diff --git a/openapi/v2/openapi-2025-02-19.json b/openapi/v2/openapi-2025-02-19.json index e96f38b0a1..0cff8f767b 100644 --- a/openapi/v2/openapi-2025-02-19.json +++ b/openapi/v2/openapi-2025-02-19.json @@ -142,6 +142,10 @@ "description": "Returns, adds, edits, or removes an online archive.", "name": "Online Archive" }, + { + "description": "Returns information about the MongoDB Atlas Specification.", + "name": "OpenAPI" + }, { "description": "Returns, adds, and edits organizational units in MongoDB Cloud.", "name": "Organizations" @@ -281,6 +285,18 @@ "tags": [ "Root" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus" } }, @@ -328,6 +344,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames" } }, @@ -378,6 +406,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects" } }, @@ -428,6 +468,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes" } }, @@ -469,6 +521,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp" } }, @@ -522,6 +586,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs" } }, @@ -577,6 +653,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig" }, "get": { @@ -636,6 +724,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig" }, "patch": { @@ -703,6 +803,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig" } }, @@ -753,6 +865,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings" }, "post": { @@ -812,6 +936,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping" } }, @@ -870,6 +1006,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping" }, "get": { @@ -932,6 +1080,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping" }, "put": { @@ -1002,6 +1162,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping" } }, @@ -1090,6 +1262,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders" }, "post": { @@ -1146,6 +1330,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider" } }, @@ -1204,6 +1400,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider" }, "get": { @@ -1262,6 +1470,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider" }, "patch": { @@ -1328,6 +1548,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider" } }, @@ -1386,6 +1618,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider" } }, @@ -1433,6 +1677,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata" } }, @@ -1489,6 +1745,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects" }, "post": { @@ -1557,6 +1825,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject" } }, @@ -1618,6 +1898,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName" } }, @@ -1668,6 +1960,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject" }, "get": { @@ -1720,6 +2024,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject" }, "patch": { @@ -1779,6 +2095,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject" } }, @@ -1846,6 +2174,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/access\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject" } @@ -1907,6 +2247,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" + } + ], "x-xgen-changelog": { "2025-05-08": "Corrects an issue where the endpoint would include Atlas internal entries." }, @@ -1985,6 +2337,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList" } }, @@ -2044,6 +2408,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList" }, "get": { @@ -2107,6 +2483,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList" } }, @@ -2171,6 +2559,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus" } }, @@ -2227,6 +2627,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations" }, "post": { @@ -2286,6 +2698,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/alertConfigs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration" } }, @@ -2345,6 +2769,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration" }, "get": { @@ -2408,6 +2844,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration" }, "patch": { @@ -2479,6 +2927,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration" }, "put": { @@ -2553,6 +3013,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration" } }, @@ -2628,6 +3100,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId" } }, @@ -2700,6 +3184,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts" } }, @@ -2764,6 +3260,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAlert --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert" }, "patch": { @@ -2837,6 +3345,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert" } }, @@ -2911,6 +3431,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId" } }, @@ -2971,6 +3503,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys" }, "post": { @@ -3027,6 +3571,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/apiKeys\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey" } }, @@ -3088,6 +3644,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey" }, "patch": { @@ -3166,6 +3734,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles" }, "post": { @@ -3232,6 +3812,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey" } }, @@ -3282,6 +3874,18 @@ "tags": [ "Auditing" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration" }, "patch": { @@ -3341,6 +3945,18 @@ "tags": [ "Auditing" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/auditLog\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration" } }, @@ -3391,6 +4007,18 @@ "tags": [ "AWS Clusters DNS" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAwsCustomDns --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns" }, "patch": { @@ -3447,6 +4075,18 @@ "tags": [ "AWS Clusters DNS" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/awsCustomDNS\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleAwsCustomDns --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns" } }, @@ -3503,6 +4143,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets" }, "post": { @@ -3639,6 +4291,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket" } }, @@ -3694,6 +4358,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket" }, "get": { @@ -3796,6 +4472,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket" } }, @@ -3843,6 +4531,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings" }, "get": { @@ -3891,6 +4591,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings" }, "put": { @@ -3960,6 +4672,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings" } }, @@ -4012,6 +4736,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles" }, "post": { @@ -4072,6 +4808,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole" } }, @@ -4143,6 +4891,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole" } }, @@ -4203,6 +4963,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole" }, "patch": { @@ -4279,6 +5051,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole" } }, @@ -4348,6 +5132,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClusters --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters" }, "post": { @@ -4535,6 +5331,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster" } }, @@ -4610,6 +5418,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions" } }, @@ -4681,6 +5501,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster" } }, @@ -4753,6 +5585,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" + } + ], "x-sunset": "2025-02-05", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless" } @@ -4826,6 +5670,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster" }, "get": { @@ -4891,6 +5747,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster" }, "patch": { @@ -4964,6 +5832,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster" } }, @@ -5028,6 +5908,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api autoScalingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration" } }, @@ -5094,6 +5986,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs" }, "post": { @@ -5163,6 +6067,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob" } }, @@ -5228,6 +6144,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob" } }, @@ -5294,6 +6222,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs" }, "post": { @@ -5366,6 +6306,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob" } }, @@ -5436,6 +6388,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob" }, "get": { @@ -5501,6 +6465,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob" } }, @@ -5558,6 +6534,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules" }, "get": { @@ -5613,6 +6601,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule" }, "patch": { @@ -5682,6 +6682,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule" } }, @@ -5751,6 +6763,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups" }, "post": { @@ -5820,6 +6844,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot" } }, @@ -5884,6 +6920,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup" }, "get": { @@ -5955,6 +7003,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup" } }, @@ -6015,6 +7075,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups" } }, @@ -6082,6 +7154,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup" }, "get": { @@ -6153,6 +7237,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup" }, "patch": { @@ -6232,6 +7328,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention" } }, @@ -6310,6 +7418,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup" } }, @@ -6388,6 +7508,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob" } }, @@ -6452,6 +7584,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs" } }, @@ -6526,6 +7670,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob" } }, @@ -6590,6 +7746,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups" } }, @@ -6664,6 +7832,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup" } }, @@ -6731,6 +7911,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints" } }, @@ -6805,6 +7997,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint" } }, @@ -6862,6 +8066,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces" }, "patch": { @@ -6939,6 +8155,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch" }, "put": { @@ -7016,6 +8244,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut" } }, @@ -7084,6 +8324,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces" } }, @@ -7163,6 +8415,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated" } @@ -7250,6 +8514,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated" } @@ -7326,6 +8602,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated" }, @@ -7400,6 +8688,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated" }, @@ -7491,6 +8791,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated" } @@ -7556,6 +8868,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace" } }, @@ -7617,6 +8941,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings" }, "post": { @@ -7691,6 +9027,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping" } }, @@ -7771,6 +9119,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace" }, "post": { @@ -7848,6 +9208,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace" } }, @@ -8011,6 +9383,18 @@ "tags": [ "Rolling Index" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex" } }, @@ -8081,6 +9465,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives" }, "post": { @@ -8157,6 +9553,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" + } + ], "x-xgen-changelog": { "2023-08-02": "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" }, @@ -8260,6 +9668,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs" } }, @@ -8328,6 +9748,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive" }, "get": { @@ -8403,6 +9835,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive" }, "patch": { @@ -8489,6 +9933,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive" } }, @@ -8553,6 +10009,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation" }, "get": { @@ -8620,6 +10088,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation" }, "post": { @@ -8693,6 +10173,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation" } }, @@ -8747,6 +10239,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDropIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes" } }, @@ -8801,6 +10305,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSchemaAdvice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice" } }, @@ -8906,6 +10422,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClusterSuggestedIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes" } }, @@ -8973,6 +10501,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration" }, "patch": { @@ -9047,6 +10587,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration" } }, @@ -9101,6 +10653,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api testFailover --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover" } }, @@ -9184,6 +10748,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs" }, "post": { @@ -9258,6 +10834,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob" } }, @@ -9337,6 +10925,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob" } }, @@ -9397,6 +10997,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment" }, "get": { @@ -9456,6 +11068,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" + } + ], "x-sunset": "2026-03-12", "x-xgen-changelog": { "2025-03-12": "Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400." @@ -9532,6 +11156,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment" }, "post": { @@ -9604,6 +11240,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment" } }, @@ -9684,6 +11332,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster" }, "post": { @@ -9760,6 +11420,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex" } }, @@ -9858,6 +11530,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes" } }, @@ -9946,6 +11630,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName" }, "get": { @@ -10035,6 +11731,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName" }, "patch": { @@ -10138,6 +11846,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName" } }, @@ -10212,6 +11932,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex" }, "get": { @@ -10297,6 +12029,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex" }, "patch": { @@ -10386,6 +12130,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex" } }, @@ -10451,6 +12207,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule" }, "patch": { @@ -10525,6 +12293,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule" } }, @@ -10610,6 +12390,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots" } }, @@ -10682,6 +12474,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot" }, "get": { @@ -10755,6 +12559,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot" }, "patch": { @@ -10836,6 +12652,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention" } }, @@ -10896,6 +12724,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus" } }, @@ -10973,6 +12813,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster" } }, @@ -11100,6 +12952,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements" } }, @@ -11172,6 +13036,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api grantMongoDbEmployeeAccess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess" } }, @@ -11243,6 +13119,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinFeatureCompatibilityVersion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion" } }, @@ -11303,6 +13191,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api revokeMongoDbEmployeeAccess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess" } }, @@ -11366,6 +13266,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api unpinFeatureCompatibilityVersion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion" } }, @@ -11467,6 +13379,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs" } }, @@ -11511,6 +13435,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics" } }, @@ -11585,6 +13521,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider" }, "post": { @@ -11647,6 +13595,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/containers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer" } }, @@ -11703,6 +13663,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers" } }, @@ -11764,6 +13736,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer" }, "get": { @@ -11823,6 +13807,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer" }, "patch": { @@ -11896,6 +13892,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/containers/{containerId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer" } }, @@ -11949,6 +13957,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles" }, "post": { @@ -12011,6 +14031,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole" } }, @@ -12070,6 +14102,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole" }, "get": { @@ -12124,6 +14168,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole" }, "patch": { @@ -12195,6 +14251,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole" } }, @@ -12266,6 +14334,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases" }, "post": { @@ -12334,6 +14414,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/dataFederation\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase" } }, @@ -12387,6 +14479,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase" }, "get": { @@ -12445,6 +14549,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase" }, "patch": { @@ -12522,6 +14638,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase" } }, @@ -12589,6 +14717,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits" } }, @@ -12657,6 +14797,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit" }, "get": { @@ -12729,6 +14881,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit" }, "patch": { @@ -12809,6 +14973,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit" } }, @@ -12889,6 +15065,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs" } }, @@ -12945,6 +15133,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers" }, "post": { @@ -13163,6 +15363,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/databaseUsers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser" } }, @@ -13231,6 +15443,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser" }, "get": { @@ -13300,6 +15524,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser" }, "patch": { @@ -13386,6 +15622,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser" } }, @@ -13454,6 +15702,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates" }, "post": { @@ -13530,6 +15790,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate" } }, @@ -13641,6 +15913,18 @@ "tags": [ "Access Tracking" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName" } }, @@ -13748,6 +16032,18 @@ "tags": [ "Access Tracking" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname" } }, @@ -13799,6 +16095,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest" }, "patch": { @@ -13861,6 +16169,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/encryptionAtRest\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest" } }, @@ -13930,6 +16250,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider" }, "post": { @@ -13999,6 +16331,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint" } }, @@ -14066,6 +16410,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion" }, "get": { @@ -14137,6 +16493,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint" } }, @@ -14269,6 +16637,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents" } }, @@ -14342,6 +16722,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent" } }, @@ -14401,6 +16793,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexClusters --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters" }, "post": { @@ -14466,6 +16870,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster" } }, @@ -14526,6 +16942,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster" }, "get": { @@ -14590,6 +17018,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster" }, "patch": { @@ -14662,6 +17102,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster" } }, @@ -14736,6 +17188,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadFlexBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup" } }, @@ -14805,6 +17269,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs" }, "post": { @@ -14877,6 +17353,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFlexBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob" } }, @@ -14947,6 +17435,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob" } }, @@ -15016,6 +17516,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups" } }, @@ -15084,6 +17596,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup" } }, @@ -15151,6 +17675,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster" } }, @@ -15201,6 +17737,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes" } }, @@ -15300,6 +17848,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics" } }, @@ -15402,6 +17962,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics" } }, @@ -15493,6 +18065,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements" } }, @@ -15552,6 +18136,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations" } }, @@ -15621,6 +18217,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration" }, "get": { @@ -15694,6 +18302,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration" }, "post": { @@ -15787,6 +18407,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration" }, "put": { @@ -15880,6 +18512,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration" } }, @@ -15948,6 +18592,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations" }, @@ -16009,6 +18665,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation" }, @@ -16067,6 +18735,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation" } @@ -16120,6 +18800,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation" }, @@ -16180,6 +18872,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation" }, @@ -16248,6 +18952,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById" } @@ -16299,6 +19015,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnAllIpAddresses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses" } }, @@ -16363,6 +19091,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits" } }, @@ -16438,6 +19178,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit" }, "get": { @@ -16517,6 +19269,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit" }, "patch": { @@ -16604,6 +19368,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/limits/{limitName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit" } }, @@ -16670,6 +19446,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/liveMigrations\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration" } }, @@ -16732,6 +19520,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/liveMigrations/validate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration" } }, @@ -16790,6 +19590,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus" } }, @@ -16840,6 +19652,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration" } }, @@ -16890,6 +19714,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration" } }, @@ -16934,6 +19770,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow" }, "get": { @@ -16982,6 +19830,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow" }, "patch": { @@ -17035,6 +19895,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/maintenanceWindow\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow" } }, @@ -17079,6 +19951,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer" } }, @@ -17123,6 +20007,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow" } }, @@ -17173,6 +20069,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs" } }, @@ -17217,6 +20125,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding" } }, @@ -17261,6 +20181,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding" } }, @@ -17367,6 +20299,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectLtsVersions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions" } }, @@ -17443,6 +20387,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections" }, "post": { @@ -17509,6 +20465,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/peers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection" } }, @@ -17569,6 +20537,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection" }, "get": { @@ -17630,6 +20610,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection" }, "patch": { @@ -17702,6 +20694,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/peers/{peerId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection" } }, @@ -17761,6 +20765,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines" }, @@ -17823,6 +20839,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline" } @@ -17876,6 +20904,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline" }, @@ -17939,6 +20979,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline" }, @@ -18010,6 +21062,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline" } @@ -18082,6 +21146,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules" } @@ -18166,6 +21242,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots" } @@ -18228,6 +21316,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline" } @@ -18290,6 +21390,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline" } @@ -18373,6 +21485,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns" } @@ -18446,6 +21570,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset" }, @@ -18520,6 +21656,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun" } @@ -18593,6 +21741,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion" } @@ -18659,6 +21819,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService" } }, @@ -18706,6 +21878,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting" }, "patch": { @@ -18765,6 +21949,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting" } }, @@ -18833,6 +22029,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints" }, "post": { @@ -18903,6 +22111,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint" } }, @@ -18967,6 +22187,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint" }, "get": { @@ -19035,6 +22267,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint" }, "patch": { @@ -19111,6 +22355,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint" } }, @@ -19190,6 +22446,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices" } }, @@ -19265,6 +22533,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService" }, "get": { @@ -19344,6 +22624,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService" } }, @@ -19439,6 +22731,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint" } }, @@ -19524,6 +22828,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint" }, "get": { @@ -19613,6 +22929,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint" } }, @@ -19668,6 +22996,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject" }, "patch": { @@ -19732,6 +23072,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateIpMode\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering" } }, @@ -19791,6 +23143,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints" }, "post": { @@ -19850,6 +23214,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint" } }, @@ -19904,6 +23280,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint" }, "get": { @@ -19962,6 +23350,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint" } }, @@ -20018,6 +23418,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses" } }, @@ -20079,6 +23491,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess" } }, @@ -20135,6 +23559,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost" } }, @@ -20206,6 +23642,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases" } }, @@ -20276,6 +23724,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase" } }, @@ -20385,6 +23845,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements" } }, @@ -20452,6 +23924,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions" } }, @@ -20519,6 +24003,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements" } }, @@ -20640,6 +24136,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements" } }, @@ -20870,6 +24378,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements" } }, @@ -20949,6 +24469,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces" } }, @@ -21079,6 +24611,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries" } }, @@ -21198,6 +24742,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes" } }, @@ -21302,6 +24858,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements" } }, @@ -21349,6 +24917,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration" }, "get": { @@ -21398,6 +24978,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration" }, "patch": { @@ -21455,6 +25047,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration" }, "post": { @@ -21512,6 +25116,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration" } }, @@ -21572,6 +25188,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset" } }, @@ -21629,6 +25257,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus" } }, @@ -21692,6 +25332,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances" }, "post": { @@ -21761,6 +25413,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance" } }, @@ -21834,6 +25498,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs" }, "post": { @@ -21910,6 +25586,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob" } }, @@ -21987,6 +25675,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob" } }, @@ -22060,6 +25760,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups" } }, @@ -22135,6 +25847,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup" } }, @@ -22196,6 +25920,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing" }, "post": { @@ -22258,6 +25994,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing" } }, @@ -22325,6 +26073,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance" }, "get": { @@ -22393,6 +26153,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance" }, "patch": { @@ -22469,6 +26241,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/serverless/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance" } }, @@ -22522,6 +26306,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts" }, "post": { @@ -22582,6 +26378,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount" } }, @@ -22638,6 +26446,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount" }, "get": { @@ -22697,6 +26517,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount" }, "patch": { @@ -22767,6 +26599,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount" } }, @@ -22834,6 +26678,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList" }, "post": { @@ -22921,6 +26777,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList" } }, @@ -22990,6 +26858,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccountAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry" } }, @@ -23062,6 +26942,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret" } }, @@ -23126,6 +27018,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret" } }, @@ -23196,6 +27100,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount" } }, @@ -23246,6 +27162,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings" }, "patch": { @@ -23302,6 +27230,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/settings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings" } }, @@ -23355,6 +27295,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23417,6 +27369,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23482,6 +27446,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAccountDetails --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails" } }, @@ -23532,6 +27508,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getActiveVpcPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections" } }, @@ -23585,6 +27573,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPrivateLinkConnections --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23650,6 +27650,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23706,6 +27718,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23760,6 +27784,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23822,6 +27858,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getVpcPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections" } }, @@ -23872,6 +27920,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection" } }, @@ -23933,6 +27993,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api acceptVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection" } }, @@ -23983,6 +28055,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api rejectVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection" } }, @@ -24036,6 +28120,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24104,6 +28200,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24175,6 +28283,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24261,6 +28381,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs" } }, @@ -24323,6 +28455,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24397,6 +28541,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24465,6 +28621,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24531,6 +28699,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24614,6 +28794,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24690,6 +28882,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor" } }, @@ -24752,6 +28956,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor" }, "get": { @@ -24821,6 +29037,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor" }, "patch": { @@ -24898,6 +29126,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api modifyStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor" } }, @@ -24960,6 +29200,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api startStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor" } }, @@ -25022,6 +29274,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api stopStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor" } }, @@ -25094,6 +29358,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamProcessors --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors" } }, @@ -25155,6 +29431,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams:withSampleConnections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamInstanceWithSampleConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections" } }, @@ -25214,6 +29502,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams" }, "post": { @@ -25280,6 +29580,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/teams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject" } }, @@ -25338,6 +29650,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam" }, "patch": { @@ -25411,6 +29735,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/teams/{teamId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles" } }, @@ -25462,6 +29798,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration" }, "patch": { @@ -25521,6 +29869,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/userSecurity\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api saveLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration" } }, @@ -25565,6 +29925,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509" } }, @@ -25612,6 +29984,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration" } }, @@ -25673,6 +30057,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api verifyLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration" } }, @@ -25730,6 +30126,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLdapConfigurationStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus" } }, @@ -25826,6 +30234,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers" }, "post": { @@ -25888,6 +30308,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser" } }, @@ -25952,6 +30384,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser" }, "get": { @@ -26010,6 +30454,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser" } }, @@ -26079,6 +30535,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/users/{userId}/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles" } @@ -26158,6 +30626,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users/{userId}:addRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole" } }, @@ -26236,6 +30716,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole" } }, @@ -26291,9 +30783,70 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}:migrate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api migrateProjectToAnotherOrg --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg" } }, + "/api/atlas/v2/openapi/info": { + "get": { + "description": "This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. Deprecated versions: v2-{2024-05-30}", + "operationId": "getOpenApiInfo", + "parameters": [ + { + "$ref": "#/components/parameters/pretty" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.atlas.2024-08-05+json": { + "schema": { + "$ref": "#/components/schemas/OpenApiInfo" + }, + "x-xgen-version": "2024-08-05" + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/unauthorized" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Return general information about the MongoDB Atlas Administration API OpenAPI Specification.", + "tags": [ + "OpenAPI" + ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/openapi/info?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOpenApiInfo --help" + } + ] + } + }, "/api/atlas/v2/orgs": { "get": { "description": "Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role.", @@ -26358,6 +30911,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations" }, "post": { @@ -26424,6 +30989,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization" } }, @@ -26474,6 +31051,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization" }, "get": { @@ -26528,6 +31117,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization" }, "patch": { @@ -26590,6 +31191,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization" } }, @@ -26650,6 +31263,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys" }, "post": { @@ -26710,6 +31335,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/apiKeys\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey" } }, @@ -26768,6 +31405,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey" }, "get": { @@ -26830,6 +31479,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey" }, "patch": { @@ -26903,6 +31564,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey" } }, @@ -26973,6 +31646,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries" }, "post": { @@ -27057,6 +31742,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList" } }, @@ -27129,6 +31826,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry" }, "get": { @@ -27199,6 +31908,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList" } }, @@ -27257,6 +31978,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess" } }, @@ -27328,6 +32061,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCostExplorerQueryProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess" } }, @@ -27436,6 +32181,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents" } }, @@ -27509,6 +32266,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent" } }, @@ -27562,6 +32331,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings" } }, @@ -27634,6 +32415,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects" } }, @@ -27709,6 +32502,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations" }, @@ -27774,6 +32579,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation" }, @@ -27839,6 +32656,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation" } @@ -27901,6 +32730,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation" }, @@ -27965,6 +32806,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation" }, @@ -28040,6 +32893,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById" } @@ -28178,6 +33043,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices" } }, @@ -28225,6 +33102,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices" } }, @@ -28294,6 +33183,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice" } }, @@ -28352,6 +33253,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCsv --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv" } }, @@ -28426,6 +33339,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api queryLineItemsFromSingleInvoice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice" } }, @@ -28482,6 +33407,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects" } }, @@ -28526,6 +33463,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken" }, "post": { @@ -28585,6 +33534,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken" } }, @@ -28649,6 +33610,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getResourcesNonCompliant --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant" } }, @@ -28714,6 +33687,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasResourcePolicies --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies" }, "post": { @@ -28786,6 +33771,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/resourcePolicies\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy" } }, @@ -28850,6 +33847,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy" }, "get": { @@ -28918,6 +33927,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy" }, "patch": { @@ -29003,6 +34024,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy" } }, @@ -29077,6 +34110,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api validateAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy" } }, @@ -29130,6 +34175,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts" }, "post": { @@ -29189,6 +34246,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount" } }, @@ -29244,6 +34313,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount" }, "get": { @@ -29303,6 +34384,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount" }, "patch": { @@ -29373,6 +34466,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount" } }, @@ -29440,6 +34545,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList" }, "post": { @@ -29527,6 +34644,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList" } }, @@ -29596,6 +34725,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry" } }, @@ -29664,6 +34805,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects" } }, @@ -29736,6 +34889,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret" } }, @@ -29800,6 +34965,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret" } }, @@ -29850,6 +35027,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings" }, "patch": { @@ -29909,6 +35098,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/settings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings" } }, @@ -29972,6 +35173,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams" }, "post": { @@ -30038,6 +35251,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam" } }, @@ -30101,6 +35326,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName" } }, @@ -30162,6 +35399,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam" }, "get": { @@ -30224,6 +35473,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById" }, "patch": { @@ -30300,6 +35561,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam" } }, @@ -30391,6 +35664,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers" }, "post": { @@ -30471,6 +35756,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser" } @@ -30544,6 +35841,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser" } @@ -30620,6 +35929,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addUserToTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam" } }, @@ -30695,6 +36016,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeUserFromTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam" } }, @@ -30776,6 +36109,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers" }, "post": { @@ -30838,6 +36183,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser" } }, @@ -30902,6 +36259,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser" }, "get": { @@ -30960,6 +36329,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser" }, "patch": { @@ -31033,6 +36414,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/users/{userId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser" } }, @@ -31102,6 +36495,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X PUT \"/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles" } @@ -31181,6 +36586,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addOrganizationRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole" } }, @@ -31256,6 +36673,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeOrganizationRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole" } }, @@ -31289,9 +36718,93 @@ "tags": [ "Root" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIpAddresses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses" } }, + "/api/atlas/v2/unauth/openapi/versions": { + "get": { + "description": "API that provides a list of available versionsfor a given environment.", + "operationId": "getApiVersions", + "parameters": [ + { + "$ref": "#/components/parameters/envelope" + }, + { + "$ref": "#/components/parameters/itemsPerPage" + }, + { + "$ref": "#/components/parameters/pageNum" + }, + { + "$ref": "#/components/parameters/pretty" + }, + { + "description": "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com).", + "in": "query", + "name": "env", + "schema": { + "enum": [ + "dev", + "qa", + "prod", + "stage" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.atlas.2024-08-05+json": { + "schema": { + "$ref": "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version": "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml": { + "schema": { + "$ref": "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version": "2024-08-05" + } + }, + "description": "OK" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Provides a list of versions for a given environment.", + "tags": [ + "OpenAPI" + ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/unauth/openapi/versions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiVersions --help" + } + ] + } + }, "/api/atlas/v2/users": { "post": { "deprecated": true, @@ -31345,6 +36858,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X POST \"/api/atlas/v2/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser" } @@ -31405,6 +36930,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername" } @@ -31468,6 +37005,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-02-19+json\" \\\n -X GET \"/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser" } } @@ -35025,6 +40574,15 @@ "title": "API User Events", "type": "object" }, + "ApiVersion": { + "properties": { + "version": { + "description": "Object representing a version of the Atlas Admin API.", + "type": "string" + } + }, + "type": "object" + }, "AppServiceAlertConfigViewForNdsGroup": { "description": "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", "properties": { @@ -56816,6 +62374,35 @@ "type": "object", "writeOnly": true }, + "Info": { + "description": "Information about the MongoDB Atlas Administration API OpenAPI Specification.", + "properties": { + "description": { + "description": "Description of the MongoDB Atlas Administration API.", + "example": "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.", + "type": "string" + }, + "license": { + "$ref": "#/components/schemas/License" + }, + "termsOfService": { + "description": "Terms of Service URL.", + "example": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "type": "string" + }, + "title": { + "description": "Title of the MongoDB Atlas Administration API.", + "example": "MongoDB Atlas Administration API.", + "type": "string" + }, + "version": { + "description": "Version of the MongoDB Atlas Administration API.", + "example": "2.0", + "type": "string" + } + }, + "type": "object" + }, "IngestionPipelineRun": { "description": "Run details of a Data Lake Pipeline.", "properties": { @@ -58553,6 +64140,22 @@ ], "type": "object" }, + "License": { + "description": "License information of the MongoDB Atlas Administration API.", + "properties": { + "name": { + "description": "Name of the license.", + "example": "CC BY-NC-SA 3.0 US", + "type": "string" + }, + "url": { + "description": "URL of the license.", + "example": "https://creativecommons.org/licenses/by-nc-sa/3.0/us/", + "type": "string" + } + }, + "type": "object" + }, "Link": { "properties": { "href": { @@ -61180,6 +66783,14 @@ "title": "Online Archive Schedule", "type": "object" }, + "OpenApiInfo": { + "properties": { + "info": { + "$ref": "#/components/schemas/Info" + } + }, + "type": "object" + }, "Operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ @@ -63065,6 +68676,38 @@ }, "type": "object" }, + "PaginatedApiVersions": { + "properties": { + "links": { + "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs": { + "description": "Web Linking Specification (RFC 5988)", + "url": "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items": { + "$ref": "#/components/schemas/Link" + }, + "readOnly": true, + "type": "array" + }, + "results": { + "description": "List of returned documents that MongoDB Cloud provides when completing this request.", + "items": { + "$ref": "#/components/schemas/ApiVersion" + }, + "readOnly": true, + "type": "array" + }, + "totalCount": { + "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.", + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "PaginatedAtlasGroupView": { "properties": { "links": { diff --git a/openapi/v2/openapi-2025-02-19.yaml b/openapi/v2/openapi-2025-02-19.yaml index 8c88361b42..10311d7dee 100644 --- a/openapi/v2/openapi-2025-02-19.yaml +++ b/openapi/v2/openapi-2025-02-19.yaml @@ -2847,6 +2847,12 @@ components: - id title: API User Events type: object + ApiVersion: + properties: + version: + description: Object representing a version of the Atlas Admin API. + type: string + type: object AppServiceAlertConfigViewForNdsGroup: description: App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified. properties: @@ -20481,6 +20487,28 @@ components: type: object type: object writeOnly: true + Info: + description: Information about the MongoDB Atlas Administration API OpenAPI Specification. + properties: + description: + description: Description of the MongoDB Atlas Administration API. + example: The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. + type: string + license: + $ref: '#/components/schemas/License' + termsOfService: + description: Terms of Service URL. + example: https://www.mongodb.com/mongodb-management-service-terms-and-conditions + type: string + title: + description: Title of the MongoDB Atlas Administration API. + example: MongoDB Atlas Administration API. + type: string + version: + description: Version of the MongoDB Atlas Administration API. + example: "2.0" + type: string + type: object IngestionPipelineRun: description: Run details of a Data Lake Pipeline. properties: @@ -21999,6 +22027,18 @@ components: - eventTypeName - notifications type: object + License: + description: License information of the MongoDB Atlas Administration API. + properties: + name: + description: Name of the license. + example: CC BY-NC-SA 3.0 US + type: string + url: + description: URL of the license. + example: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ + type: string + type: object Link: properties: href: @@ -24146,6 +24186,11 @@ components: - type title: Online Archive Schedule type: object + OpenApiInfo: + properties: + info: + $ref: '#/components/schemas/Info' + type: object Operator: description: Comparison operator to apply when checking the current metric value. enum: @@ -25647,6 +25692,30 @@ components: readOnly: true type: integer type: object + PaginatedApiVersions: + properties: + links: + description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: '#/components/schemas/Link' + readOnly: true + type: array + results: + description: List of returned documents that MongoDB Cloud provides when completing this request. + items: + $ref: '#/components/schemas/ApiVersion' + readOnly: true + type: array + totalCount: + description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. + format: int32 + minimum: 0 + readOnly: true + type: integer + type: object PaginatedAtlasGroupView: properties: links: @@ -34408,6 +34477,17 @@ paths: summary: Return the status of this MongoDB application tags: - Root + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus /api/atlas/v2/alertConfigs/matchers/fieldNames: get: @@ -34437,6 +34517,17 @@ paths: summary: Get All Alert Configuration Matchers Field Names tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames /api/atlas/v2/clusters: get: @@ -34465,6 +34556,17 @@ paths: summary: Return All Authorized Clusters in All Projects tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/clusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects /api/atlas/v2/eventTypes: get: @@ -34493,6 +34595,17 @@ paths: summary: List All Possible Event Types tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/eventTypes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes /api/atlas/v2/federationSettings/{federationSettingsId}: delete: @@ -34519,6 +34632,17 @@ paths: summary: Delete One Federation Settings Instance tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: @@ -34550,6 +34674,17 @@ paths: summary: Return All Connected Org Configs from One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: @@ -34585,6 +34720,17 @@ paths: summary: Remove One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. @@ -34623,6 +34769,17 @@ paths: summary: Return One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected." @@ -34666,6 +34823,18 @@ paths: summary: Update One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: @@ -34696,6 +34865,17 @@ paths: summary: Return All Role Mappings from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34732,6 +34912,18 @@ paths: summary: Add One Role Mapping to One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: @@ -34768,6 +34960,17 @@ paths: summary: Remove One Role Mapping from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34807,6 +35010,17 @@ paths: summary: Return One Role Mapping from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34851,6 +35065,18 @@ paths: summary: Update One Role Mapping in One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: @@ -34906,6 +35132,17 @@ paths: summary: Return All Identity Providers in One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders post: description: |- @@ -34944,6 +35181,18 @@ paths: summary: Create One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: @@ -34981,6 +35230,17 @@ paths: summary: Delete One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' @@ -35018,6 +35278,17 @@ paths: summary: Return One Identity Provider by ID tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider patch: description: |- @@ -35063,6 +35334,18 @@ paths: summary: Update One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: @@ -35100,6 +35383,17 @@ paths: summary: Revoke the JWKS from One OIDC Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: @@ -35129,6 +35423,17 @@ paths: summary: Return the Metadata of One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata /api/atlas/v2/groups: get: @@ -35161,6 +35466,17 @@ paths: summary: Return All Projects tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects post: description: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. @@ -35204,6 +35520,18 @@ paths: summary: Create One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject /api/atlas/v2/groups/{groupId}: delete: @@ -35234,6 +35562,17 @@ paths: summary: Remove One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -35266,6 +35605,17 @@ paths: summary: Return One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject patch: description: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -35302,6 +35652,18 @@ paths: summary: Update One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject /api/atlas/v2/groups/{groupId}/access: post: @@ -35343,6 +35705,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/access" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject /api/atlas/v2/groups/{groupId}/accessList: @@ -35378,6 +35752,17 @@ paths: summary: Return Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help x-xgen-changelog: "2025-05-08": Corrects an issue where the endpoint would include Atlas internal entries. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists @@ -35424,6 +35809,18 @@ paths: summary: Add Entries to Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: @@ -35466,6 +35863,17 @@ paths: summary: Remove One Entry from One Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList get: description: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (`/groups/{GROUP-ID}/accessList`) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (`/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`) manages those access lists. @@ -35506,6 +35914,17 @@ paths: summary: Return One Project IP Access List Entry tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: @@ -35546,6 +35965,17 @@ paths: summary: Return Status of One Project IP Access List Entry tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus /api/atlas/v2/groups/{groupId}/alertConfigs: get: @@ -35580,6 +36010,17 @@ paths: summary: Return All Alert Configurations for One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations post: description: |- @@ -35619,6 +36060,18 @@ paths: summary: Create One Alert Configuration in One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/alertConfigs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: @@ -35659,6 +36112,17 @@ paths: summary: Remove One Alert Configuration from One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration get: description: |- @@ -35702,6 +36166,17 @@ paths: summary: Return One Alert Configuration from One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration patch: description: |- @@ -35752,6 +36227,18 @@ paths: summary: Toggle One State of One Alert Configuration in One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration put: description: |- @@ -35804,6 +36291,18 @@ paths: summary: Update One Alert Configuration for One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: @@ -35852,6 +36351,17 @@ paths: summary: Return All Open Alerts for Alert Configuration tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId /api/atlas/v2/groups/{groupId}/alerts: get: @@ -35897,6 +36407,17 @@ paths: summary: Return All Alerts from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: @@ -35940,6 +36461,17 @@ paths: summary: Return One Alert from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert patch: description: |- @@ -35989,6 +36521,18 @@ paths: summary: Acknowledge One Alert from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -36036,6 +36580,17 @@ paths: summary: Return All Alert Configurations Set for One Alert tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId /api/atlas/v2/groups/{groupId}/apiKeys: get: @@ -36070,6 +36625,17 @@ paths: summary: Return All Organization API Keys Assigned to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys post: description: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36104,6 +36670,18 @@ paths: summary: Create and Assign One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/apiKeys" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: @@ -36142,6 +36720,17 @@ paths: summary: Unassign One Organization API Key from One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. @@ -36188,6 +36777,18 @@ paths: summary: Update Roles of One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36229,6 +36830,18 @@ paths: summary: Assign One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey /api/atlas/v2/groups/{groupId}/auditLog: get: @@ -36259,6 +36872,17 @@ paths: summary: Return the Auditing Configuration for One Project tags: - Auditing + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration patch: description: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -36295,6 +36919,18 @@ paths: summary: Update Auditing Configuration for One Project tags: - Auditing + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/auditLog" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: @@ -36325,6 +36961,17 @@ paths: summary: Return One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAwsCustomDns --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns patch: description: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -36359,6 +37006,18 @@ paths: summary: Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/awsCustomDNS" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleAwsCustomDns --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: @@ -36390,6 +37049,17 @@ paths: summary: Return All Snapshot Export Buckets tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets post: description: 'Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36480,6 +37150,18 @@ paths: summary: Create One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -36515,6 +37197,17 @@ paths: summary: Delete One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket get: description: 'Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -36582,6 +37275,17 @@ paths: summary: Return One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: delete: @@ -36610,6 +37314,17 @@ paths: summary: Disable the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" + - label: Atlas CLI + lang: cURL + source: atlas api disableDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36639,6 +37354,17 @@ paths: summary: Return the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36682,6 +37408,18 @@ paths: summary: Update or enable the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: @@ -36714,6 +37452,17 @@ paths: summary: Return All Cloud Provider Access Roles tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles post: description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36751,6 +37500,18 @@ paths: summary: Create One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/cloudProviderAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: @@ -36796,6 +37557,17 @@ paths: summary: Deauthorize One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: @@ -36833,6 +37605,17 @@ paths: summary: Return specified Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. @@ -36881,6 +37664,18 @@ paths: summary: Authorize One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/clusters: get: @@ -36924,6 +37719,17 @@ paths: summary: Return All Clusters in One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters post: description: |- @@ -37052,6 +37858,18 @@ paths: summary: Create One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -37100,6 +37918,17 @@ paths: summary: Remove One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster get: description: |- @@ -37144,6 +37973,17 @@ paths: summary: Return One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster patch: description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster''s termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can''t modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}' @@ -37190,6 +38030,18 @@ paths: summary: Modify One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -37277,6 +38129,17 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: @@ -37324,6 +38187,17 @@ paths: summary: Return Ranked Namespaces from a Cluster tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: @@ -37364,6 +38238,17 @@ paths: summary: Get cluster internal configuration of sharded cluster AutoScaling operations tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api autoScalingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: @@ -37402,6 +38287,17 @@ paths: summary: Return All Snapshot Export Jobs tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs post: description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -37446,6 +38342,18 @@ paths: summary: Create One Snapshot Export Job tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: @@ -37488,6 +38396,17 @@ paths: summary: Return One Snapshot Export Job tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: @@ -37526,6 +38445,17 @@ paths: summary: Return All Restore Jobs for One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs post: description: |- @@ -37574,6 +38504,18 @@ paths: summary: Restore One Snapshot of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: @@ -37618,6 +38560,17 @@ paths: summary: Cancel One Restore Job of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. @@ -37659,6 +38612,17 @@ paths: summary: Return One Restore Job of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: @@ -37695,6 +38659,17 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules get: description: 'Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -37729,6 +38704,17 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule patch: description: 'Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -37775,6 +38761,18 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -37815,6 +38813,17 @@ paths: summary: Return All Replica Set Cloud Backups tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups post: description: |- @@ -37861,6 +38870,18 @@ paths: summary: Take One On-Demand Snapshot tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: @@ -37903,6 +38924,17 @@ paths: summary: Remove One Replica Set Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. @@ -37948,6 +38980,17 @@ paths: summary: Return One Replica Set Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the Project Backup Manager role. @@ -37998,6 +39041,18 @@ paths: summary: Change Expiration Date for One Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: @@ -38038,6 +39093,17 @@ paths: summary: Remove One Sharded Cluster Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. @@ -38083,6 +39149,17 @@ paths: summary: Return One Sharded Cluster Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: @@ -38120,6 +39197,17 @@ paths: summary: Return All Sharded Cluster Cloud Backups tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: @@ -38172,6 +39260,18 @@ paths: summary: Download One M2 or M5 Cluster Snapshot tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: @@ -38224,6 +39324,18 @@ paths: summary: Create One Restore Job from One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: @@ -38267,6 +39379,17 @@ paths: summary: Return All Restore Jobs for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: @@ -38317,6 +39440,17 @@ paths: summary: Return One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: @@ -38360,6 +39494,17 @@ paths: summary: Return All Snapshots for One M2 or M5 Cluster tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: @@ -38410,6 +39555,17 @@ paths: summary: Return One Snapshot for One M2 or M5 Cluster tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: @@ -38449,6 +39605,17 @@ paths: summary: Return All Legacy Backup Checkpoints tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: @@ -38496,6 +39663,17 @@ paths: summary: Return One Legacy Backup Checkpoint tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: @@ -38532,6 +39710,17 @@ paths: summary: Return Pinned Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. @@ -38581,6 +39770,18 @@ paths: summary: Add Pinned Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch put: description: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. @@ -38630,6 +39831,18 @@ paths: summary: Pin Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: @@ -38673,6 +39886,18 @@ paths: summary: Unpin namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: @@ -38723,6 +39948,18 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: @@ -38779,6 +40016,17 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: @@ -38828,6 +40076,17 @@ paths: summary: Remove One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated get: @@ -38876,6 +40135,17 @@ paths: summary: Return One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated patch: @@ -38935,6 +40205,18 @@ paths: summary: Update One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: @@ -38976,6 +40258,17 @@ paths: summary: Return One Managed Namespace in One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -39014,6 +40307,17 @@ paths: summary: Remove All Custom Zone Mappings from One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings post: description: 'Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -39061,6 +40365,18 @@ paths: summary: Add One Entry to One Custom Zone Mapping tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -39111,6 +40427,17 @@ paths: summary: Remove One Managed Namespace from One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace post: description: 'Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -39160,6 +40487,18 @@ paths: summary: Create One Managed Namespace in One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -39270,6 +40609,18 @@ paths: summary: Create One Rolling Index tags: - Rolling Index + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: @@ -39311,6 +40662,17 @@ paths: summary: Return All Online Archives for One Cluster tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -39359,6 +40721,18 @@ paths: summary: Create One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help x-xgen-changelog: "2023-08-02": If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive @@ -39404,6 +40778,17 @@ paths: summary: Remove One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive get: description: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -39452,6 +40837,17 @@ paths: summary: Return One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive patch: description: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -39507,6 +40903,18 @@ paths: summary: Update One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: @@ -39574,6 +40982,17 @@ paths: summary: Download Online Archive Query Logs tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: @@ -39614,6 +41033,17 @@ paths: summary: End an Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation get: description: Returns one outage simulation for one cluster. @@ -39657,6 +41087,17 @@ paths: summary: Return One Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation post: description: Starts a cluster outage simulation. @@ -39703,6 +41144,18 @@ paths: summary: Start an Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions: get: @@ -39738,6 +41191,17 @@ paths: summary: Returns Suggested Indexes to Drop tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDropIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice: get: @@ -39773,6 +41237,17 @@ paths: summary: Return Schema Advice tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSchemaAdvice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: get: @@ -39851,6 +41326,17 @@ paths: summary: Return Suggested Indexes tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClusterSuggestedIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: @@ -39893,6 +41379,17 @@ paths: summary: Return One Advanced Configuration Options for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration patch: description: 'Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -39940,6 +41437,18 @@ paths: summary: Update Advanced Configuration Options for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -39973,6 +41482,18 @@ paths: summary: Test Failover for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: @@ -40026,6 +41547,17 @@ paths: summary: Return All Legacy Backup Restore Jobs tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs post: deprecated: true @@ -40073,6 +41605,18 @@ paths: summary: Create One Legacy Backup Restore Job tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: @@ -40127,6 +41671,17 @@ paths: summary: Return One Legacy Backup Restore Job tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: @@ -40164,6 +41719,17 @@ paths: summary: Delete Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment get: deprecated: true @@ -40201,6 +41767,17 @@ paths: summary: Return Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help x-sunset: "2026-03-12" x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. @@ -40249,6 +41826,18 @@ paths: summary: Update Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment post: description: Creates Search Nodes for the specified cluster. @@ -40294,6 +41883,18 @@ paths: summary: Create Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: @@ -40344,6 +41945,17 @@ paths: summary: Return All Atlas Search Indexes for One Cluster tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster post: description: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40392,6 +42004,18 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: @@ -40454,6 +42078,17 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: @@ -40510,6 +42145,17 @@ paths: summary: Remove One Atlas Search Index by Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName get: description: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. @@ -40567,6 +42213,17 @@ paths: summary: Return One Atlas Search Index by Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName patch: description: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40633,6 +42290,18 @@ paths: summary: Update One Atlas Search Index By Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: @@ -40680,6 +42349,17 @@ paths: summary: Remove One Atlas Search Index by Id tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex get: description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. @@ -40734,6 +42414,17 @@ paths: summary: Return One Atlas Search Index by ID tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex patch: description: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40791,6 +42482,18 @@ paths: summary: Update One Atlas Search Index By ID tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -40835,6 +42538,17 @@ paths: summary: Return One Snapshot Schedule tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule patch: deprecated: true @@ -40885,6 +42599,18 @@ paths: summary: Update Snapshot Schedule for One Cluster tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: @@ -40937,6 +42663,17 @@ paths: summary: Return All Legacy Backup Snapshots tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: @@ -40983,6 +42720,17 @@ paths: summary: Remove One Legacy Backup Snapshot tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot get: deprecated: true @@ -41030,6 +42778,17 @@ paths: summary: Return One Legacy Backup Snapshot tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot patch: deprecated: true @@ -41082,6 +42841,18 @@ paths: summary: Change One Legacy Backup Snapshot Expiration tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: @@ -41119,6 +42890,17 @@ paths: summary: Return Status of All Cluster Operations tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: post: @@ -41164,6 +42946,18 @@ paths: summary: Grant MongoDB employee cluster access for one cluster. tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api grantMongoDbEmployeeAccess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: @@ -41208,6 +43002,18 @@ paths: summary: Pin FCV for One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinFeatureCompatibilityVersion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: post: @@ -41245,6 +43051,18 @@ paths: summary: Revoke granted MongoDB employee cluster access for one cluster. tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api revokeMongoDbEmployeeAccess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: @@ -41284,6 +43102,18 @@ paths: summary: Unpins FCV for One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api unpinFeatureCompatibilityVersion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: @@ -41352,6 +43182,17 @@ paths: summary: Download Logs for One Cluster Host in One Project tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: @@ -41395,6 +43236,17 @@ paths: summary: Return All Cloud Provider Regions tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: @@ -41439,6 +43291,18 @@ paths: summary: Upgrade One Shared-tier Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: @@ -41487,6 +43351,18 @@ paths: summary: Upgrades One Shared-Tier Cluster to the Serverless Instance tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help x-sunset: "2025-02-05" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless /api/atlas/v2/groups/{groupId}/collStats/metrics: @@ -41515,6 +43391,17 @@ paths: summary: Return all metric names tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics /api/atlas/v2/groups/{groupId}/containers: get: @@ -41559,6 +43446,17 @@ paths: summary: Return All Network Peering Containers in One Project for One Cloud Provider tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider post: description: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -41597,6 +43495,18 @@ paths: summary: Create One New Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/containers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: @@ -41635,6 +43545,17 @@ paths: summary: Remove One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/containers/{containerId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer get: description: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -41672,6 +43593,17 @@ paths: summary: Return One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -41718,6 +43650,18 @@ paths: summary: Update One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/containers/{containerId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer /api/atlas/v2/groups/{groupId}/containers/all: get: @@ -41749,6 +43693,17 @@ paths: summary: Return All Network Peering Containers in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: @@ -41781,6 +43736,17 @@ paths: summary: Return All Custom Roles in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles post: description: Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -41819,6 +43785,18 @@ paths: summary: Create One Custom Role tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/customDBRoles/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: @@ -41855,6 +43833,17 @@ paths: summary: Remove One Custom Role from One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole get: description: Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -41888,6 +43877,17 @@ paths: summary: Return One Custom Role in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole patch: description: Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -41932,6 +43932,18 @@ paths: summary: Update One Custom Role in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole /api/atlas/v2/groups/{groupId}/dataFederation: get: @@ -41977,6 +43989,17 @@ paths: summary: Return All Federated Database Instances in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases post: description: Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. @@ -42019,6 +44042,18 @@ paths: summary: Create One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/dataFederation" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: @@ -42051,6 +44086,17 @@ paths: summary: Remove One Federated Database Instance from One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -42088,6 +44134,17 @@ paths: summary: Return One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. @@ -42136,6 +44193,18 @@ paths: summary: Update One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: @@ -42178,6 +44247,17 @@ paths: summary: Return All Query Limits for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: @@ -42230,6 +44310,17 @@ paths: summary: Delete One Query Limit For One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit get: description: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -42284,6 +44375,17 @@ paths: summary: Return One Federated Database Instance Query Limit for One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -42344,6 +44446,18 @@ paths: summary: Configure One Query Limit for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: @@ -42398,6 +44512,17 @@ paths: summary: Download Query Logs for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs /api/atlas/v2/groups/{groupId}/databaseUsers: get: @@ -42429,6 +44554,17 @@ paths: summary: Return All Database Users from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers post: description: Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -42561,6 +44697,18 @@ paths: summary: Create One Database User in One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/databaseUsers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: @@ -42617,6 +44765,17 @@ paths: summary: Remove One Database User from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser get: description: Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -42674,6 +44833,17 @@ paths: summary: Return One Database User from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -42742,6 +44912,18 @@ paths: summary: Update One Database User in One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: @@ -42781,6 +44963,17 @@ paths: summary: Return All X.509 Certificates Assigned to One MongoDB User tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates post: description: |- @@ -42834,6 +45027,18 @@ paths: summary: Create One X.509 Certificate for One MongoDB User tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: @@ -42906,6 +45111,17 @@ paths: summary: Return Database Access History for One Cluster using Its Cluster Name tags: - Access Tracking + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: @@ -42975,6 +45191,17 @@ paths: summary: Return Database Access History for One Cluster using Its Hostname tags: - Access Tracking + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: @@ -43009,6 +45236,17 @@ paths: summary: Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest patch: description: |- @@ -43059,6 +45297,18 @@ paths: summary: Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/encryptionAtRest" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: @@ -43099,6 +45349,17 @@ paths: summary: Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. @@ -43142,6 +45403,18 @@ paths: summary: Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: @@ -43184,6 +45457,17 @@ paths: summary: Delete Private Endpoint for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -43229,6 +45513,17 @@ paths: summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/events: get: @@ -43320,6 +45615,17 @@ paths: summary: Return All Events from One Project tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/events?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents /api/atlas/v2/groups/{groupId}/events/{eventId}: get: @@ -43369,6 +45675,17 @@ paths: summary: Return One Event from One Project tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent /api/atlas/v2/groups/{groupId}/flexClusters: get: @@ -43402,6 +45719,17 @@ paths: summary: Return All Flex Clusters from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexClusters --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters post: description: Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43442,6 +45770,18 @@ paths: summary: Create One Flex Cluster in One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}: delete: @@ -43479,6 +45819,17 @@ paths: summary: Remove One Flex Cluster from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster get: description: Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -43519,6 +45870,17 @@ paths: summary: Return One Flex Cluster from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster patch: description: Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43564,6 +45926,18 @@ paths: summary: Update One Flex Cluster in One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download: post: @@ -43610,6 +45984,18 @@ paths: summary: Download One Flex Cluster Snapshot tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api downloadFlexBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: @@ -43650,6 +46036,17 @@ paths: summary: Return All Restore Jobs for One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs post: description: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43695,6 +46092,18 @@ paths: summary: Restore One Snapshot of One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFlexBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}: get: @@ -43739,6 +46148,17 @@ paths: summary: Return One Restore Job for One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots: get: @@ -43779,6 +46199,17 @@ paths: summary: Return All Snapshots of One Flex Cluster tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}: get: @@ -43823,6 +46254,17 @@ paths: summary: Return One Snapshot of One Flex Cluster tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: post: @@ -43864,6 +46306,18 @@ paths: summary: Upgrade One Flex Cluster tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: @@ -43894,6 +46348,17 @@ paths: summary: Return All Atlas Search Metric Types for One Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: @@ -43956,6 +46421,17 @@ paths: summary: Return Atlas Search Metrics for One Index in One Specified Namespace tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: @@ -44017,6 +46493,17 @@ paths: summary: Return All Atlas Search Index Metrics for One Namespace tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: @@ -44075,6 +46562,17 @@ paths: summary: Return Atlas Search Hardware and Status Metrics tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements /api/atlas/v2/groups/{groupId}/integrations: get: @@ -44108,6 +46606,17 @@ paths: summary: Return All Active Third-Party Service Integrations tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/integrations?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: @@ -44154,6 +46663,17 @@ paths: summary: Remove One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration get: description: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44203,6 +46723,17 @@ paths: summary: Return One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration post: description: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per `{INTEGRATION-TYPE}`. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44262,6 +46793,18 @@ paths: summary: Configure One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration put: description: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44321,6 +46864,18 @@ paths: summary: Update One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration /api/atlas/v2/groups/{groupId}/invites: get: @@ -44364,6 +46919,17 @@ paths: summary: Return All Project Invitations tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/invites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations patch: @@ -44402,6 +46968,18 @@ paths: summary: Update One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation post: @@ -44438,6 +47016,18 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation /api/atlas/v2/groups/{groupId}/invites/{invitationId}: @@ -44472,6 +47062,17 @@ paths: summary: Cancel One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation get: @@ -44510,6 +47111,17 @@ paths: summary: Return One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation patch: @@ -44554,6 +47166,18 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById /api/atlas/v2/groups/{groupId}/ipAddresses: @@ -44585,6 +47209,17 @@ paths: summary: Return All IP Addresses for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIpAddresses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses /api/atlas/v2/groups/{groupId}/limits: get: @@ -44625,6 +47260,17 @@ paths: summary: Return All Limits for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/limits?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: @@ -44693,6 +47339,17 @@ paths: summary: Remove One Project Limit tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/limits/{limitName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit get: description: Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -44764,6 +47421,17 @@ paths: summary: Return One Limit for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit patch: description: |- @@ -44843,6 +47511,18 @@ paths: summary: Set One Project Limit tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/limits/{limitName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit /api/atlas/v2/groups/{groupId}/liveMigrations: post: @@ -44891,6 +47571,18 @@ paths: summary: Migrate One Local Managed Cluster to MongoDB Atlas tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/liveMigrations" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -44920,6 +47612,17 @@ paths: summary: Return One Migration Job tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: @@ -44949,6 +47652,18 @@ paths: summary: Cut Over the Migrated Cluster tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: @@ -44987,6 +47702,18 @@ paths: summary: Validate One Migration Request tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -45024,6 +47751,17 @@ paths: summary: Return One Migration Validation Job tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: @@ -45051,6 +47789,17 @@ paths: summary: Reset One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/maintenanceWindow" + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45080,6 +47829,17 @@ paths: summary: Return One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow patch: description: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45113,6 +47873,18 @@ paths: summary: Update Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/maintenanceWindow" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: @@ -45140,6 +47912,18 @@ paths: summary: Toggle Automatic Deferral of Maintenance for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: @@ -45167,6 +47951,18 @@ paths: summary: Defer One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow /api/atlas/v2/groups/{groupId}/managedSlowMs: get: @@ -45197,6 +47993,17 @@ paths: summary: Return Managed Slow MS enabled tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: @@ -45223,6 +48030,17 @@ paths: summary: Disable Managed Slow Operation Threshold tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: @@ -45249,6 +48067,18 @@ paths: summary: Enable Managed Slow Operation Threshold tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: @@ -45317,6 +48147,17 @@ paths: summary: Return Available MongoDB LTS Versions for clusters in One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLtsVersions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions /api/atlas/v2/groups/{groupId}/peers: get: @@ -45362,6 +48203,17 @@ paths: summary: Return All Network Peering Connections in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/peers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections post: description: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. @@ -45403,6 +48255,18 @@ paths: summary: Create One New Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/peers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: @@ -45440,6 +48304,17 @@ paths: summary: Remove One Existing Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/peers/{peerId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -45478,6 +48353,17 @@ paths: summary: Return One Network Peering Connection in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45523,6 +48409,18 @@ paths: summary: Update One New Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/peers/{peerId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection /api/atlas/v2/groups/{groupId}/pipelines: get: @@ -45561,6 +48459,17 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines post: @@ -45601,6 +48510,18 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: @@ -45635,6 +48556,17 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline get: @@ -45675,6 +48607,17 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline patch: @@ -45721,6 +48664,18 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: @@ -45767,6 +48722,17 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: @@ -45818,6 +48784,17 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: @@ -45857,6 +48834,18 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: @@ -45896,6 +48885,18 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: @@ -45946,6 +48947,17 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: @@ -45993,6 +49005,17 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset get: @@ -46041,6 +49064,17 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: @@ -46087,6 +49121,18 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: @@ -46139,6 +49185,17 @@ paths: summary: Return All Private Endpoint Services for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: @@ -46187,6 +49244,17 @@ paths: summary: Remove One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService get: description: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -46238,6 +49306,17 @@ paths: summary: Return One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: @@ -46299,6 +49378,18 @@ paths: summary: Create One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: @@ -46354,6 +49445,17 @@ paths: summary: Remove One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint get: description: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -46412,6 +49514,17 @@ paths: summary: Return One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: @@ -46452,6 +49565,18 @@ paths: summary: Create One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: @@ -46480,6 +49605,17 @@ paths: summary: Return Regionalized Private Endpoint Status tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. @@ -46516,6 +49652,18 @@ paths: summary: Toggle Regionalized Private Endpoint Status tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: @@ -46563,6 +49711,17 @@ paths: summary: Return All Private Endpoints for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints post: description: |- @@ -46613,6 +49772,18 @@ paths: summary: Create One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: @@ -46657,6 +49828,17 @@ paths: summary: Remove One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint get: description: |- @@ -46704,6 +49886,17 @@ paths: summary: Return One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint patch: description: |- @@ -46756,6 +49949,18 @@ paths: summary: Update One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateIpMode: get: @@ -46790,6 +49995,17 @@ paths: summary: Verify Connect via Peering Only Mode for One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject patch: deprecated: true @@ -46830,6 +50046,18 @@ paths: summary: Disable Connect via Peering Only Mode for One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateIpMode" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: @@ -46863,6 +50091,17 @@ paths: summary: Return All Federated Database Instance and Online Archive Private Endpoints in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints post: description: |- @@ -46918,6 +50157,18 @@ paths: summary: Create One Federated Database Instance and Online Archive Private Endpoint for One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: @@ -46951,6 +50202,17 @@ paths: summary: Remove One Federated Database Instance and Online Archive Private Endpoint from One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -46987,6 +50249,17 @@ paths: summary: Return One Federated Database Instance and Online Archive Private Endpoint in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint /api/atlas/v2/groups/{groupId}/processes: get: @@ -47018,6 +50291,17 @@ paths: summary: Return All MongoDB Processes in One Project tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses /api/atlas/v2/groups/{groupId}/processes/{processId}: get: @@ -47056,6 +50340,17 @@ paths: summary: Return One MongoDB Process by ID tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -47125,6 +50420,17 @@ paths: summary: Return Host-Level Query Latency tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: @@ -47156,6 +50462,17 @@ paths: summary: Return Ranked Namespaces from a Host tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: @@ -47198,6 +50515,17 @@ paths: summary: Return Available Databases for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: @@ -47242,6 +50570,17 @@ paths: summary: Return One Database for a MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: @@ -47312,6 +50651,17 @@ paths: summary: Return Measurements of One Database for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: @@ -47351,6 +50701,17 @@ paths: summary: Return Available Disks for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: @@ -47394,6 +50755,17 @@ paths: summary: Return Measurements of One Disk tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: @@ -47483,6 +50855,17 @@ paths: summary: Return Measurements of One Disk for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: @@ -47685,6 +51068,17 @@ paths: summary: Return Measurements for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: @@ -47743,6 +51137,17 @@ paths: summary: Return All Namespaces for One Host tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: @@ -47836,6 +51241,17 @@ paths: summary: Return Slow Queries tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: @@ -47918,6 +51334,17 @@ paths: summary: Return Suggested Indexes tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: @@ -47946,6 +51373,17 @@ paths: summary: Disable the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration get: description: Fetches the current project level settings for the push-based log export feature. @@ -47976,6 +51414,17 @@ paths: summary: Get the push-based log export configuration for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration patch: description: Updates the project level settings for the push-based log export feature. @@ -48011,6 +51460,18 @@ paths: summary: Update the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration post: description: Configures the project level settings for the push-based log export feature. @@ -48046,6 +51507,18 @@ paths: summary: Enable the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: @@ -48084,6 +51557,18 @@ paths: summary: Load Sample Dataset Request into Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: @@ -48120,6 +51605,17 @@ paths: summary: Check Status of Cluster Sample Dataset Request tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus /api/atlas/v2/groups/{groupId}/serverless: get: @@ -48159,6 +51655,17 @@ paths: summary: Return All Serverless Instances from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances post: description: |- @@ -48205,6 +51712,18 @@ paths: summary: Create One Serverless Instance in One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: @@ -48251,6 +51770,17 @@ paths: summary: Return All Restore Jobs for One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs post: description: |- @@ -48302,6 +51832,18 @@ paths: summary: Restore One Snapshot of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: @@ -48354,6 +51896,17 @@ paths: summary: Return One Restore Job for One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: @@ -48400,6 +51953,17 @@ paths: summary: Return All Snapshots of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: @@ -48452,6 +52016,17 @@ paths: summary: Return One Snapshot of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: @@ -48490,6 +52065,17 @@ paths: summary: Return Serverless Auto Indexing Enabled tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. @@ -48530,6 +52116,18 @@ paths: summary: Set Serverless Auto Indexing tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: @@ -48575,6 +52173,17 @@ paths: summary: Remove One Serverless Instance from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serverless/{name}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance get: description: |- @@ -48621,6 +52230,17 @@ paths: summary: Return One Serverless Instance from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance patch: description: |- @@ -48672,6 +52292,18 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/serverless/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance /api/atlas/v2/groups/{groupId}/serviceAccounts: get: @@ -48702,6 +52334,17 @@ paths: summary: List All Project Service Accounts tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts post: description: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. @@ -48739,6 +52382,18 @@ paths: summary: Create and Assign one Service Account to one Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: @@ -48774,6 +52429,17 @@ paths: summary: Unassign One Service Account from One Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount get: description: Returns one Service Account in the specified Project. @@ -48811,6 +52477,17 @@ paths: summary: Get one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount patch: description: Updates one Service Account in the specified Project. @@ -48855,6 +52532,18 @@ paths: summary: Update one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: get: @@ -48894,6 +52583,17 @@ paths: summary: Return All Access List entries for one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList post: description: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. @@ -48947,6 +52647,18 @@ paths: summary: Add Access List entries for one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: @@ -48991,6 +52703,17 @@ paths: summary: Remove One Access List entry from one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccountAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets: post: @@ -49036,6 +52759,18 @@ paths: summary: Create one Project Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: @@ -49076,6 +52811,17 @@ paths: summary: Delete one Project Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: post: @@ -49120,6 +52866,18 @@ paths: summary: Assign One Service Account to One Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount /api/atlas/v2/groups/{groupId}/settings: get: @@ -49150,6 +52908,17 @@ paths: summary: Return One Project Settings tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/settings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings patch: description: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -49184,6 +52953,18 @@ paths: summary: Update One Project Settings tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/settings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings /api/atlas/v2/groups/{groupId}/streams: get: @@ -49214,6 +52995,17 @@ paths: summary: Return All Project Stream Instances tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances @@ -49252,6 +53044,18 @@ paths: summary: Create One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance @@ -49286,6 +53090,17 @@ paths: summary: Delete One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance @@ -49329,6 +53144,17 @@ paths: summary: Return One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance @@ -49373,6 +53199,18 @@ paths: summary: Update One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance @@ -49430,6 +53268,17 @@ paths: summary: Download Audit Logs for One Atlas Stream Processing Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: @@ -49466,6 +53315,17 @@ paths: summary: Return All Connections Of The Stream Instances tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections @@ -49512,6 +53372,18 @@ paths: summary: Create One Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection @@ -49554,6 +53426,17 @@ paths: summary: Delete One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection @@ -49596,6 +53479,17 @@ paths: summary: Return One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection @@ -49648,6 +53542,18 @@ paths: summary: Update One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection @@ -49695,6 +53601,18 @@ paths: summary: Create One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: @@ -49733,6 +53651,17 @@ paths: summary: Delete One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -49776,6 +53705,17 @@ paths: summary: Get One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor patch: description: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -49824,6 +53764,18 @@ paths: summary: Modify One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api modifyStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: @@ -49862,6 +53814,18 @@ paths: summary: Start One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: @@ -49900,6 +53864,18 @@ paths: summary: Stop One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api stopStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: @@ -49942,6 +53918,17 @@ paths: summary: Return All Stream Processors In The Stream Instance. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamProcessors --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors /api/atlas/v2/groups/{groupId}/streams/accountDetails: get: @@ -49981,6 +53968,17 @@ paths: summary: Returns the Account ID, and the VPC ID for the group and region specified. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAccountDetails --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: @@ -50009,6 +54007,17 @@ paths: summary: Returns all the active incoming VPC Peering Connections. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getActiveVpcPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: get: @@ -50039,6 +54048,17 @@ paths: summary: Return All Private Link tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateLinkConnections --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections @@ -50079,6 +54099,18 @@ paths: summary: Create One Private Link connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection @@ -50113,6 +54145,17 @@ paths: summary: Delete One Private Link connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection @@ -50147,6 +54190,17 @@ paths: summary: Return One PrivateLink Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection @@ -50183,6 +54237,17 @@ paths: summary: Return All VPC Peering Connections. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getVpcPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: delete: @@ -50214,6 +54279,17 @@ paths: summary: Deletes an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: post: @@ -50252,6 +54328,18 @@ paths: summary: Requests the acceptance of an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api acceptVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: post: @@ -50283,6 +54371,18 @@ paths: summary: Requests the rejection of an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api rejectVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: post: @@ -50320,6 +54420,18 @@ paths: summary: Create One Stream Instance With Sample Connections tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstanceWithSampleConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections /api/atlas/v2/groups/{groupId}/teams: get: @@ -50353,6 +54465,17 @@ paths: summary: Return All Teams in One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/teams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams post: description: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -50394,6 +54517,18 @@ paths: summary: Add One or More Teams to One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/teams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: @@ -50431,6 +54566,17 @@ paths: summary: Remove One Team from One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/teams/{teamId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam patch: description: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -50477,6 +54623,18 @@ paths: summary: Update Team Roles in One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/teams/{teamId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles /api/atlas/v2/groups/{groupId}/userSecurity: get: @@ -50508,6 +54666,17 @@ paths: summary: Return the Current LDAP or X.509 Configuration tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration patch: description: |- @@ -50547,6 +54716,18 @@ paths: summary: Edit the LDAP or X.509 Configuration tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/userSecurity" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api saveLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: @@ -50577,6 +54758,17 @@ paths: summary: Disable Customer-Managed X.509 tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: @@ -50605,6 +54797,17 @@ paths: summary: Remove the Current LDAP User to DN Mapping tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: @@ -50642,6 +54845,18 @@ paths: summary: Verify the LDAP Configuration in One Project tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api verifyLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: @@ -50677,6 +54892,17 @@ paths: summary: Return the Status of One Verify LDAP Configuration Request tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLdapConfigurationStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus /api/atlas/v2/groups/{groupId}/users: get: @@ -50740,6 +54966,17 @@ paths: summary: Return All MongoDB Cloud Users in One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers post: description: "Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. \n- If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. \n- If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. \n- If the user is already active in the project's organization, MongoDB Cloud grants access to the project. \n" @@ -50778,6 +55015,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser /api/atlas/v2/groups/{groupId}/users/{userId}: delete: @@ -50823,6 +55072,17 @@ paths: summary: Remove One MongoDB Cloud User from One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser get: description: |- @@ -50864,6 +55124,17 @@ paths: summary: Return One MongoDB Cloud User in One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: @@ -50907,6 +55178,18 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/users/{userId}/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles /api/atlas/v2/groups/{groupId}/users/{userId}:addRole: @@ -50960,6 +55243,18 @@ paths: summary: Add One Project Role to One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users/{userId}:addRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole: post: @@ -51012,6 +55307,18 @@ paths: summary: Remove One Project Role from One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole /api/atlas/v2/groups/{groupId}:migrate: post: @@ -51046,6 +55353,18 @@ paths: summary: Migrate One Project to Another Organization tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/groups/{groupId}:migrate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api migrateProjectToAnotherOrg --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg /api/atlas/v2/groups/byName/{groupName}: get: @@ -51085,7 +55404,52 @@ paths: summary: Return One Project using Its Name tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/groups/byName/{groupName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName + /api/atlas/v2/openapi/info: + get: + description: 'This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. Deprecated versions: v2-{2024-05-30}' + operationId: getOpenApiInfo + parameters: + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: '#/components/schemas/OpenApiInfo' + x-xgen-version: "2024-08-05" + description: OK + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return general information about the MongoDB Atlas Administration API OpenAPI Specification. + tags: + - OpenAPI + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/openapi/info?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOpenApiInfo --help /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51124,6 +55488,17 @@ paths: summary: Return All Organizations tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations post: description: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. @@ -51166,6 +55541,18 @@ paths: summary: Create One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization /api/atlas/v2/orgs/{orgId}: delete: @@ -51202,6 +55589,17 @@ paths: summary: Remove One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization get: description: Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51235,6 +55633,17 @@ paths: summary: Return One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization patch: description: Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -51273,6 +55682,18 @@ paths: summary: Update One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization /api/atlas/v2/orgs/{orgId}/apiKeys: get: @@ -51307,6 +55728,17 @@ paths: summary: Return All Organization API Keys tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys post: description: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -51344,6 +55776,18 @@ paths: summary: Create One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/apiKeys" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: @@ -51380,6 +55824,17 @@ paths: summary: Remove One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey get: description: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51419,6 +55874,17 @@ paths: summary: Return One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey patch: description: Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -51465,6 +55931,18 @@ paths: summary: Update One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: @@ -51506,6 +55984,17 @@ paths: summary: Return All Access List Entries for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries post: description: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. @@ -51556,6 +56045,18 @@ paths: summary: Create Access List Entries for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: @@ -51602,6 +56103,17 @@ paths: summary: Remove One Access List Entry for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51647,6 +56159,17 @@ paths: summary: Return One Access List Entry for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: @@ -51683,6 +56206,18 @@ paths: summary: Create Cost Explorer query process tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: @@ -51729,6 +56264,17 @@ paths: summary: Return results from a given Cost Explorer query, or notify that the results are not ready yet. tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCostExplorerQueryProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess /api/atlas/v2/orgs/{orgId}/events: get: @@ -51801,6 +56347,17 @@ paths: summary: Return All Events from One Organization tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/events?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: @@ -51850,6 +56407,17 @@ paths: summary: Return One Event from One Organization tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent /api/atlas/v2/orgs/{orgId}/federationSettings: get: @@ -51882,6 +56450,17 @@ paths: summary: Return Federation Settings for One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings /api/atlas/v2/orgs/{orgId}/groups: get: @@ -51932,6 +56511,17 @@ paths: summary: Return One or More Projects in One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects /api/atlas/v2/orgs/{orgId}/invites: get: @@ -51983,6 +56573,17 @@ paths: summary: Return All Organization Invitations tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations patch: @@ -52027,6 +56628,18 @@ paths: summary: Update One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation post: @@ -52071,6 +56684,18 @@ paths: summary: Invite One MongoDB Cloud User to Join One Atlas Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: @@ -52113,6 +56738,17 @@ paths: summary: Cancel One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation get: @@ -52158,6 +56794,17 @@ paths: summary: Return One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation patch: @@ -52209,6 +56856,18 @@ paths: summary: Update One Organization Invitation by Invitation ID tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById /api/atlas/v2/orgs/{orgId}/invoices: @@ -52301,6 +56960,17 @@ paths: summary: Return All Invoices for One Organization tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: @@ -52346,6 +57016,17 @@ paths: summary: Return One Organization Invoice tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: @@ -52390,6 +57071,17 @@ paths: summary: Return One Organization Invoice as CSV tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCsv --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: @@ -52435,6 +57127,17 @@ paths: summary: Query lineItems of the specified invoiceId tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api queryLineItemsFromSingleInvoice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice /api/atlas/v2/orgs/{orgId}/invoices/pending: get: @@ -52463,6 +57166,17 @@ paths: summary: Return All Pending Invoices for One Organization tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: @@ -52497,6 +57211,17 @@ paths: summary: Return All Projects Available for Migration tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: @@ -52524,6 +57249,17 @@ paths: summary: Remove One Link-Token tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken post: description: Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. @@ -52560,6 +57296,18 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken /api/atlas/v2/orgs/{orgId}/nonCompliantResources: get: @@ -52600,6 +57348,17 @@ paths: summary: Return all non-compliant resources tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getResourcesNonCompliant --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant /api/atlas/v2/orgs/{orgId}/resourcePolicies: get: @@ -52641,6 +57400,17 @@ paths: summary: Return all Atlas Resource Policies tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasResourcePolicies --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies post: description: Create one Atlas Resource Policy for an org. @@ -52686,6 +57456,18 @@ paths: summary: Create one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/resourcePolicies" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: delete: @@ -52727,6 +57509,17 @@ paths: summary: Delete one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy get: description: Return one Atlas Resource Policy for an org. @@ -52771,6 +57564,17 @@ paths: summary: Return one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy patch: description: Update one Atlas Resource Policy for an org. @@ -52826,6 +57630,18 @@ paths: summary: Update one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: post: @@ -52872,6 +57688,18 @@ paths: summary: Validate one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api validateAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: @@ -52902,6 +57730,17 @@ paths: summary: List All Organization Service Accounts tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts post: description: Creates one Service Account for the specified Organization. @@ -52938,6 +57777,18 @@ paths: summary: Create one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: @@ -52972,6 +57823,17 @@ paths: summary: Delete one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount get: description: Returns the specified Service Account. @@ -53009,6 +57871,17 @@ paths: summary: Get one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount patch: description: Updates the specified Service Account in the specified Organization. @@ -53053,6 +57926,18 @@ paths: summary: Update one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList: get: @@ -53092,6 +57977,17 @@ paths: summary: Return All Access List entries for one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList post: description: Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. @@ -53145,6 +58041,18 @@ paths: summary: Add Access List entries for one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: @@ -53189,6 +58097,17 @@ paths: summary: Remove One Access List entry from one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: @@ -53230,6 +58149,17 @@ paths: summary: Return All Service Account Project assignments tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: @@ -53275,6 +58205,18 @@ paths: summary: Create one Organization Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: @@ -53315,6 +58257,17 @@ paths: summary: Delete a Organization Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret /api/atlas/v2/orgs/{orgId}/settings: get: @@ -53345,6 +58298,17 @@ paths: summary: Return Settings for One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/settings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings patch: description: Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53381,6 +58345,18 @@ paths: summary: Update Settings for One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/settings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings /api/atlas/v2/orgs/{orgId}/teams: get: @@ -53417,6 +58393,17 @@ paths: summary: Return All Teams in One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams post: description: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53458,6 +58445,18 @@ paths: summary: Create One Team in One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: @@ -53496,6 +58495,17 @@ paths: summary: Remove One Team from One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/teams/{teamId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam get: description: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -53535,6 +58545,17 @@ paths: summary: Return One Team using its ID tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById patch: description: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53583,6 +58604,18 @@ paths: summary: Rename One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/teams/{teamId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: @@ -53644,6 +58677,17 @@ paths: summary: Return All MongoDB Cloud Users Assigned to One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers post: deprecated: true @@ -53698,6 +58742,18 @@ paths: summary: Assign MongoDB Cloud Users from One Organization to One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: @@ -53748,6 +58804,17 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: @@ -53799,6 +58866,18 @@ paths: summary: Add One MongoDB Cloud User to One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addUserToTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser: post: @@ -53849,6 +58928,18 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeUserFromTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: @@ -53888,6 +58979,17 @@ paths: summary: Return One Team using its Name tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName /api/atlas/v2/orgs/{orgId}/users: get: @@ -53941,6 +59043,17 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers post: description: |- @@ -53982,6 +59095,18 @@ paths: summary: Add One MongoDB Cloud User to One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: @@ -54027,6 +59152,17 @@ paths: summary: Remove One MongoDB Cloud User From One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser get: description: |- @@ -54068,6 +59204,17 @@ paths: summary: Return One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser patch: description: |- @@ -54119,6 +59266,18 @@ paths: summary: Update One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/users/{userId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: @@ -54162,6 +59321,18 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X PUT "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: @@ -54217,6 +59388,18 @@ paths: summary: Add One Organization Role to One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addOrganizationRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: post: @@ -54269,6 +59452,18 @@ paths: summary: Remove One Organization Role from One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole /api/atlas/v2/unauth/controlPlaneIPAddresses: get: @@ -54290,7 +59485,65 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIpAddresses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses + /api/atlas/v2/unauth/openapi/versions: + get: + description: API that provides a list of available versionsfor a given environment. + operationId: getApiVersions + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/itemsPerPage' + - $ref: '#/components/parameters/pageNum' + - $ref: '#/components/parameters/pretty' + - description: The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com). + in: query + name: env + schema: + enum: + - dev + - qa + - prod + - stage + type: string + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: '#/components/schemas/PaginatedApiVersions' + x-xgen-version: "2024-08-05" + application/vnd.atlas.2024-08-05+yaml: + schema: + $ref: '#/components/schemas/PaginatedApiVersions' + x-xgen-version: "2024-08-05" + description: OK + "500": + $ref: '#/components/responses/internalServerError' + summary: Provides a list of versions for a given environment. + tags: + - OpenAPI + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/unauth/openapi/versions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiVersions --help /api/atlas/v2/users: post: deprecated: true @@ -54330,6 +59583,18 @@ paths: summary: Create One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X POST "/api/atlas/v2/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser /api/atlas/v2/users/{userId}: @@ -54371,6 +59636,17 @@ paths: summary: Return One MongoDB Cloud User using Its ID tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser /api/atlas/v2/users/byName/{userName}: get: @@ -54409,6 +59685,17 @@ paths: summary: Return One MongoDB Cloud User using Their Username tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-02-19+json" \ + -X GET "/api/atlas/v2/users/byName/{userName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername security: @@ -54486,6 +59773,8 @@ tags: name: Network Peering - description: Returns, adds, edits, or removes an online archive. name: Online Archive + - description: Returns information about the MongoDB Atlas Specification. + name: OpenAPI - description: Returns, adds, and edits organizational units in MongoDB Cloud. name: Organizations - description: Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. diff --git a/openapi/v2/openapi-2025-03-12.json b/openapi/v2/openapi-2025-03-12.json index e817670f88..53b33754b5 100644 --- a/openapi/v2/openapi-2025-03-12.json +++ b/openapi/v2/openapi-2025-03-12.json @@ -142,6 +142,10 @@ "description": "Returns, adds, edits, or removes an online archive.", "name": "Online Archive" }, + { + "description": "Returns information about the MongoDB Atlas Specification.", + "name": "OpenAPI" + }, { "description": "Returns, adds, and edits organizational units in MongoDB Cloud.", "name": "Organizations" @@ -281,6 +285,18 @@ "tags": [ "Root" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus" } }, @@ -328,6 +344,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames" } }, @@ -378,6 +406,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects" } }, @@ -428,6 +468,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes" } }, @@ -469,6 +521,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp" } }, @@ -522,6 +586,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs" } }, @@ -577,6 +653,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig" }, "get": { @@ -636,6 +724,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig" }, "patch": { @@ -703,6 +803,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig" } }, @@ -753,6 +865,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings" }, "post": { @@ -812,6 +936,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping" } }, @@ -870,6 +1006,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping" }, "get": { @@ -932,6 +1080,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping" }, "put": { @@ -1002,6 +1162,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping" } }, @@ -1090,6 +1262,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders" }, "post": { @@ -1146,6 +1330,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider" } }, @@ -1204,6 +1400,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider" }, "get": { @@ -1262,6 +1470,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider" }, "patch": { @@ -1328,6 +1548,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider" } }, @@ -1386,6 +1618,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider" } }, @@ -1433,6 +1677,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata" } }, @@ -1489,6 +1745,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects" }, "post": { @@ -1557,6 +1825,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject" } }, @@ -1618,6 +1898,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName" } }, @@ -1668,6 +1960,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject" }, "get": { @@ -1720,6 +2024,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject" }, "patch": { @@ -1779,6 +2095,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject" } }, @@ -1846,6 +2174,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/access\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject" } @@ -1907,6 +2247,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" + } + ], "x-xgen-changelog": { "2025-05-08": "Corrects an issue where the endpoint would include Atlas internal entries." }, @@ -1985,6 +2337,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList" } }, @@ -2044,6 +2408,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList" }, "get": { @@ -2107,6 +2483,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList" } }, @@ -2171,6 +2559,18 @@ "tags": [ "Project IP Access List" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus" } }, @@ -2227,6 +2627,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations" }, "post": { @@ -2286,6 +2698,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/alertConfigs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration" } }, @@ -2345,6 +2769,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration" }, "get": { @@ -2408,6 +2844,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration" }, "patch": { @@ -2479,6 +2927,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration" }, "put": { @@ -2553,6 +3013,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration" } }, @@ -2628,6 +3100,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId" } }, @@ -2700,6 +3184,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts" } }, @@ -2764,6 +3260,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAlert --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert" }, "patch": { @@ -2837,6 +3345,18 @@ "tags": [ "Alerts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert" } }, @@ -2911,6 +3431,18 @@ "tags": [ "Alert Configurations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId" } }, @@ -2971,6 +3503,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys" }, "post": { @@ -3027,6 +3571,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/apiKeys\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey" } }, @@ -3088,6 +3644,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey" }, "patch": { @@ -3166,6 +3734,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles" }, "post": { @@ -3232,6 +3812,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey" } }, @@ -3282,6 +3874,18 @@ "tags": [ "Auditing" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration" }, "patch": { @@ -3341,6 +3945,18 @@ "tags": [ "Auditing" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/auditLog\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration" } }, @@ -3391,6 +4007,18 @@ "tags": [ "AWS Clusters DNS" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAwsCustomDns --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns" }, "patch": { @@ -3447,6 +4075,18 @@ "tags": [ "AWS Clusters DNS" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/awsCustomDNS\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleAwsCustomDns --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns" } }, @@ -3503,6 +4143,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets" }, "post": { @@ -3639,6 +4291,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket" } }, @@ -3694,6 +4358,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket" }, "get": { @@ -3796,6 +4472,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket" } }, @@ -3843,6 +4531,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings" }, "get": { @@ -3891,6 +4591,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings" }, "put": { @@ -3960,6 +4672,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings" } }, @@ -4012,6 +4736,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles" }, "post": { @@ -4072,6 +4808,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole" } }, @@ -4143,6 +4891,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole" } }, @@ -4203,6 +4963,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole" }, "patch": { @@ -4279,6 +5051,18 @@ "tags": [ "Cloud Provider Access" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole" } }, @@ -4348,6 +5132,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClusters --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters" }, "post": { @@ -4535,6 +5331,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster" } }, @@ -4610,6 +5418,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions" } }, @@ -4681,6 +5501,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster" } }, @@ -4753,6 +5585,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" + } + ], "x-sunset": "2025-02-05", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless" } @@ -4826,6 +5670,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster" }, "get": { @@ -4891,6 +5747,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster" }, "patch": { @@ -4964,6 +5832,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster" } }, @@ -5028,6 +5908,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api autoScalingConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration" } }, @@ -5094,6 +5986,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs" }, "post": { @@ -5163,6 +6067,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob" } }, @@ -5228,6 +6144,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob" } }, @@ -5294,6 +6222,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs" }, "post": { @@ -5366,6 +6306,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob" } }, @@ -5436,6 +6388,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob" }, "get": { @@ -5501,6 +6465,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob" } }, @@ -5558,6 +6534,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules" }, "get": { @@ -5613,6 +6601,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule" }, "patch": { @@ -5682,6 +6682,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule" } }, @@ -5751,6 +6763,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups" }, "post": { @@ -5820,6 +6844,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot" } }, @@ -5884,6 +6920,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup" }, "get": { @@ -5955,6 +7003,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup" } }, @@ -6015,6 +7075,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups" } }, @@ -6082,6 +7154,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup" }, "get": { @@ -6153,6 +7237,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup" }, "patch": { @@ -6232,6 +7328,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention" } }, @@ -6310,6 +7418,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup" } }, @@ -6388,6 +7508,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob" } }, @@ -6452,6 +7584,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs" } }, @@ -6526,6 +7670,18 @@ "tags": [ "Shared-Tier Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob" } }, @@ -6590,6 +7746,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups" } }, @@ -6664,6 +7832,18 @@ "tags": [ "Shared-Tier Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup" } }, @@ -6731,6 +7911,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints" } }, @@ -6805,6 +7997,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint" } }, @@ -6862,6 +8066,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces" }, "patch": { @@ -6939,6 +8155,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch" }, "put": { @@ -7016,6 +8244,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut" } }, @@ -7084,6 +8324,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces" } }, @@ -7163,6 +8415,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated" } @@ -7250,6 +8514,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated" } @@ -7326,6 +8602,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated" }, @@ -7400,6 +8688,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated" }, @@ -7491,6 +8791,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" + } + ], "x-sunset": "2026-11-30", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated" } @@ -7556,6 +8868,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace" } }, @@ -7617,6 +8941,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings" }, "post": { @@ -7691,6 +9027,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping" } }, @@ -7771,6 +9119,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace" }, "post": { @@ -7848,6 +9208,18 @@ "tags": [ "Global Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace" } }, @@ -8011,6 +9383,18 @@ "tags": [ "Rolling Index" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex" } }, @@ -8081,6 +9465,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives" }, "post": { @@ -8157,6 +9553,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" + } + ], "x-xgen-changelog": { "2023-08-02": "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" }, @@ -8260,6 +9668,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs" } }, @@ -8328,6 +9748,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive" }, "get": { @@ -8403,6 +9835,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive" }, "patch": { @@ -8489,6 +9933,18 @@ "tags": [ "Online Archive" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive" } }, @@ -8553,6 +10009,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation" }, "get": { @@ -8620,6 +10088,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation" }, "post": { @@ -8693,6 +10173,18 @@ "tags": [ "Cluster Outage Simulation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation" } }, @@ -8747,6 +10239,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDropIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes" } }, @@ -8801,6 +10305,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSchemaAdvice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice" } }, @@ -8906,6 +10422,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listClusterSuggestedIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes" } }, @@ -8973,6 +10501,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration" }, "patch": { @@ -9047,6 +10587,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration" } }, @@ -9101,6 +10653,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api testFailover --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover" } }, @@ -9184,6 +10748,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs" }, "post": { @@ -9258,6 +10834,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob" } }, @@ -9337,6 +10925,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob" } }, @@ -9397,6 +10997,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment" }, "get": { @@ -9455,6 +11067,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" + } + ], "x-xgen-changelog": { "2025-03-12": "Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400." }, @@ -9530,6 +11154,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment" }, "post": { @@ -9602,6 +11238,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment" } }, @@ -9682,6 +11330,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster" }, "post": { @@ -9758,6 +11418,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex" } }, @@ -9856,6 +11528,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes" } }, @@ -9944,6 +11628,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName" }, "get": { @@ -10033,6 +11729,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName" }, "patch": { @@ -10136,6 +11844,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName" } }, @@ -10210,6 +11930,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex" }, "get": { @@ -10295,6 +12027,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex" }, "patch": { @@ -10384,6 +12128,18 @@ "tags": [ "Atlas Search" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndex --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex" } }, @@ -10449,6 +12205,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule" }, "patch": { @@ -10523,6 +12291,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule" } }, @@ -10608,6 +12388,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots" } }, @@ -10680,6 +12472,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot" }, "get": { @@ -10753,6 +12557,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot" }, "patch": { @@ -10834,6 +12650,18 @@ "tags": [ "Legacy Backup" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention" } }, @@ -10894,6 +12722,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus" } }, @@ -10971,6 +12811,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster" } }, @@ -11098,6 +12950,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements" } }, @@ -11170,6 +13034,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api grantMongoDbEmployeeAccess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess" } }, @@ -11241,6 +13117,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pinFeatureCompatibilityVersion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion" } }, @@ -11301,6 +13189,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api revokeMongoDbEmployeeAccess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess" } }, @@ -11364,6 +13264,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api unpinFeatureCompatibilityVersion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion" } }, @@ -11465,6 +13377,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs" } }, @@ -11509,6 +13433,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics" } }, @@ -11583,6 +13519,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider" }, "post": { @@ -11645,6 +13593,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/containers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer" } }, @@ -11701,6 +13661,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers" } }, @@ -11762,6 +13734,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer" }, "get": { @@ -11821,6 +13805,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer" }, "patch": { @@ -11894,6 +13890,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/containers/{containerId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer" } }, @@ -11947,6 +13955,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles" }, "post": { @@ -12009,6 +14029,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole" } }, @@ -12068,6 +14100,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole" }, "get": { @@ -12122,6 +14166,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole" }, "patch": { @@ -12193,6 +14249,18 @@ "tags": [ "Custom Database Roles" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole" } }, @@ -12264,6 +14332,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases" }, "post": { @@ -12332,6 +14412,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/dataFederation\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase" } }, @@ -12385,6 +14477,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase" }, "get": { @@ -12443,6 +14547,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase" }, "patch": { @@ -12520,6 +14636,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase" } }, @@ -12587,6 +14715,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits" } }, @@ -12655,6 +14795,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit" }, "get": { @@ -12727,6 +14879,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit" }, "patch": { @@ -12807,6 +14971,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit" } }, @@ -12887,6 +15063,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs" } }, @@ -12943,6 +15131,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers" }, "post": { @@ -13161,6 +15361,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/databaseUsers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser" } }, @@ -13229,6 +15441,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser" }, "get": { @@ -13298,6 +15522,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser" }, "patch": { @@ -13384,6 +15620,18 @@ "tags": [ "Database Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser" } }, @@ -13452,6 +15700,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates" }, "post": { @@ -13528,6 +15788,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate" } }, @@ -13639,6 +15911,18 @@ "tags": [ "Access Tracking" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName" } }, @@ -13746,6 +16030,18 @@ "tags": [ "Access Tracking" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname" } }, @@ -13797,6 +16093,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest" }, "patch": { @@ -13859,6 +16167,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/encryptionAtRest\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest" } }, @@ -13928,6 +16248,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider" }, "post": { @@ -13997,6 +16329,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint" } }, @@ -14064,6 +16408,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion" }, "get": { @@ -14135,6 +16491,18 @@ "tags": [ "Encryption at Rest using Customer Key Management" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint" } }, @@ -14267,6 +16635,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents" } }, @@ -14340,6 +16720,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent" } }, @@ -14399,6 +16791,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexClusters --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters" }, "post": { @@ -14464,6 +16868,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster" } }, @@ -14524,6 +16940,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster" }, "get": { @@ -14588,6 +17016,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster" }, "patch": { @@ -14660,6 +17100,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster" } }, @@ -14734,6 +17186,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadFlexBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup" } }, @@ -14803,6 +17267,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs" }, "post": { @@ -14875,6 +17351,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createFlexBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob" } }, @@ -14945,6 +17433,18 @@ "tags": [ "Flex Restore Jobs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob" } }, @@ -15014,6 +17514,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listFlexBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups" } }, @@ -15082,6 +17594,18 @@ "tags": [ "Flex Snapshots" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFlexBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup" } }, @@ -15149,6 +17673,18 @@ "tags": [ "Flex Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api upgradeFlexCluster --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster" } }, @@ -15199,6 +17735,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes" } }, @@ -15298,6 +17846,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics" } }, @@ -15400,6 +17960,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics" } }, @@ -15491,6 +18063,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements" } }, @@ -15550,6 +18134,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations" } }, @@ -15619,6 +18215,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration" }, "get": { @@ -15692,6 +18300,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration" }, "post": { @@ -15785,6 +18405,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration" }, "put": { @@ -15878,6 +18510,18 @@ "tags": [ "Third-Party Integrations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration" } }, @@ -15946,6 +18590,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations" }, @@ -16007,6 +18663,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation" }, @@ -16065,6 +18733,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation" } @@ -16118,6 +18798,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation" }, @@ -16178,6 +18870,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation" }, @@ -16246,6 +18950,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById" } @@ -16297,6 +19013,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnAllIpAddresses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses" } }, @@ -16361,6 +19089,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits" } }, @@ -16436,6 +19176,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit" }, "get": { @@ -16515,6 +19267,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit" }, "patch": { @@ -16602,6 +19366,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/limits/{limitName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit" } }, @@ -16668,6 +19444,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/liveMigrations\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration" } }, @@ -16730,6 +19518,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/liveMigrations/validate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration" } }, @@ -16788,6 +19588,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus" } }, @@ -16838,6 +19650,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration" } }, @@ -16888,6 +19712,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration" } }, @@ -16932,6 +19768,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow" }, "get": { @@ -16980,6 +19828,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow" }, "patch": { @@ -17033,6 +19893,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/maintenanceWindow\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow" } }, @@ -17077,6 +19949,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer" } }, @@ -17121,6 +20005,18 @@ "tags": [ "Maintenance Windows" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow" } }, @@ -17171,6 +20067,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs" } }, @@ -17215,6 +20123,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding" } }, @@ -17259,6 +20179,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding" } }, @@ -17365,6 +20297,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectLtsVersions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions" } }, @@ -17441,6 +20385,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections" }, "post": { @@ -17507,6 +20463,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/peers\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection" } }, @@ -17567,6 +20535,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection" }, "get": { @@ -17628,6 +20608,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection" }, "patch": { @@ -17700,6 +20692,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/peers/{peerId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection" } }, @@ -17759,6 +20763,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines" }, @@ -17821,6 +20837,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline" } @@ -17874,6 +20902,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline" }, @@ -17937,6 +20977,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline" }, @@ -18008,6 +21060,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline" } @@ -18080,6 +21144,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules" } @@ -18164,6 +21240,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots" } @@ -18226,6 +21314,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline" } @@ -18288,6 +21388,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline" } @@ -18371,6 +21483,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns" } @@ -18444,6 +21568,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset" }, @@ -18518,6 +21654,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun" } @@ -18591,6 +21739,18 @@ "tags": [ "Data Lake Pipelines" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" + } + ], "x-sunset": "2025-09-09", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion" } @@ -18657,6 +21817,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService" } }, @@ -18704,6 +21876,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting" }, "patch": { @@ -18763,6 +21947,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting" } }, @@ -18831,6 +22027,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints" }, "post": { @@ -18901,6 +22109,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint" } }, @@ -18965,6 +22185,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint" }, "get": { @@ -19033,6 +22265,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint" }, "patch": { @@ -19109,6 +22353,18 @@ "tags": [ "Serverless Private Endpoints" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint" } }, @@ -19188,6 +22444,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices" } }, @@ -19263,6 +22531,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService" }, "get": { @@ -19342,6 +22622,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService" } }, @@ -19437,6 +22729,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint" } }, @@ -19522,6 +22826,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint" }, "get": { @@ -19611,6 +22927,18 @@ "tags": [ "Private Endpoint Services" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint" } }, @@ -19666,6 +22994,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject" }, "patch": { @@ -19730,6 +23070,18 @@ "tags": [ "Network Peering" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/privateIpMode\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering" } }, @@ -19789,6 +23141,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints" }, "post": { @@ -19848,6 +23212,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint" } }, @@ -19902,6 +23278,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint" }, "get": { @@ -19960,6 +23348,18 @@ "tags": [ "Data Federation" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint" } }, @@ -20016,6 +23416,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses" } }, @@ -20077,6 +23489,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess" } }, @@ -20133,6 +23557,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost" } }, @@ -20204,6 +23640,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases" } }, @@ -20274,6 +23722,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase" } }, @@ -20383,6 +23843,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements" } }, @@ -20450,6 +23922,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions" } }, @@ -20517,6 +24001,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements" } }, @@ -20638,6 +24134,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements" } }, @@ -20868,6 +24376,18 @@ "tags": [ "Monitoring and Logs" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements" } }, @@ -20947,6 +24467,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces" } }, @@ -21077,6 +24609,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries" } }, @@ -21196,6 +24740,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes" } }, @@ -21300,6 +24856,18 @@ "tags": [ "Collection Level Metrics" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements" } }, @@ -21347,6 +24915,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration" }, "get": { @@ -21396,6 +24976,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration" }, "patch": { @@ -21453,6 +25045,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration" }, "post": { @@ -21510,6 +25114,18 @@ "tags": [ "Push-Based Log Export" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration" } }, @@ -21570,6 +25186,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset" } }, @@ -21627,6 +25255,18 @@ "tags": [ "Clusters" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus" } }, @@ -21690,6 +25330,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances" }, "post": { @@ -21759,6 +25411,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance" } }, @@ -21832,6 +25496,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs" }, "post": { @@ -21908,6 +25584,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob" } }, @@ -21985,6 +25673,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob" } }, @@ -22058,6 +25758,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups" } }, @@ -22133,6 +25845,18 @@ "tags": [ "Cloud Backups" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup" } }, @@ -22194,6 +25918,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing" }, "post": { @@ -22256,6 +25992,18 @@ "tags": [ "Performance Advisor" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing" } }, @@ -22323,6 +26071,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance" }, "get": { @@ -22391,6 +26151,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance" }, "patch": { @@ -22467,6 +26239,18 @@ "tags": [ "Serverless Instances" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/serverless/{name}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance" } }, @@ -22520,6 +26304,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts" }, "post": { @@ -22580,6 +26376,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount" } }, @@ -22636,6 +26444,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount" }, "get": { @@ -22695,6 +26515,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount" }, "patch": { @@ -22765,6 +26597,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount" } }, @@ -22832,6 +26676,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList" }, "post": { @@ -22919,6 +26775,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList" } }, @@ -22988,6 +26856,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccountAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry" } }, @@ -23060,6 +26940,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret" } }, @@ -23124,6 +27016,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret" } }, @@ -23194,6 +27098,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount" } }, @@ -23244,6 +27160,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings" }, "patch": { @@ -23300,6 +27228,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/settings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings" } }, @@ -23353,6 +27293,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23415,6 +27367,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23480,6 +27444,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAccountDetails --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails" } }, @@ -23530,6 +27506,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getActiveVpcPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections" } }, @@ -23583,6 +27571,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPrivateLinkConnections --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23648,6 +27648,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createPrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23704,6 +27716,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deletePrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23758,6 +27782,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getPrivateLinkConnection --help" + } + ], "x-xgen-changelog": { "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." }, @@ -23820,6 +27856,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getVpcPeeringConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections" } }, @@ -23870,6 +27918,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection" } }, @@ -23931,6 +27991,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api acceptVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection" } }, @@ -23981,6 +28053,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api rejectVpcPeeringConnection --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection" } }, @@ -24034,6 +28118,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24102,6 +28198,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24173,6 +28281,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24259,6 +28379,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs" } }, @@ -24321,6 +28453,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24395,6 +28539,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24463,6 +28619,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24529,6 +28697,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24612,6 +28792,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" + } + ], "x-xgen-changelog": { "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, @@ -24688,6 +28880,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor" } }, @@ -24750,6 +28954,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor" }, "get": { @@ -24819,6 +29035,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor" }, "patch": { @@ -24896,6 +29124,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api modifyStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor" } }, @@ -24958,6 +29198,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api startStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor" } }, @@ -25031,6 +29283,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api startStreamProcessorWith --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessorWith" } }, @@ -25093,6 +29357,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api stopStreamProcessor --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor" } }, @@ -25165,6 +29441,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listStreamProcessors --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors" } }, @@ -25226,6 +29514,18 @@ "tags": [ "Streams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/streams:withSampleConnections\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createStreamInstanceWithSampleConnections --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections" } }, @@ -25285,6 +29585,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams" }, "post": { @@ -25351,6 +29663,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/teams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject" } }, @@ -25409,6 +29733,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam" }, "patch": { @@ -25482,6 +29818,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/teams/{teamId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles" } }, @@ -25533,6 +29881,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration" }, "patch": { @@ -25592,6 +29952,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/groups/{groupId}/userSecurity\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api saveLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration" } }, @@ -25636,6 +30008,18 @@ "tags": [ "X.509 Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509" } }, @@ -25683,6 +30067,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration" } }, @@ -25744,6 +30140,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api verifyLdapConfiguration --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration" } }, @@ -25801,6 +30209,18 @@ "tags": [ "LDAP Configuration" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getLdapConfigurationStatus --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus" } }, @@ -25897,6 +30317,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers" }, "post": { @@ -25959,6 +30391,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser" } }, @@ -26023,6 +30467,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser" }, "get": { @@ -26081,6 +30537,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getProjectUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser" } }, @@ -26150,6 +30618,18 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/groups/{groupId}/users/{userId}/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles" } @@ -26229,6 +30709,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users/{userId}:addRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addProjectRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole" } }, @@ -26307,6 +30799,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeProjectRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole" } }, @@ -26362,9 +30866,70 @@ "tags": [ "Projects" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/groups/{groupId}:migrate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api migrateProjectToAnotherOrg --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg" } }, + "/api/atlas/v2/openapi/info": { + "get": { + "description": "This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. Deprecated versions: v2-{2024-05-30}", + "operationId": "getOpenApiInfo", + "parameters": [ + { + "$ref": "#/components/parameters/pretty" + } + ], + "responses": { + "200": { + "content": { + "application/vnd.atlas.2024-08-05+json": { + "schema": { + "$ref": "#/components/schemas/OpenApiInfo" + }, + "x-xgen-version": "2024-08-05" + } + }, + "description": "OK" + }, + "401": { + "$ref": "#/components/responses/unauthorized" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Return general information about the MongoDB Atlas Administration API OpenAPI Specification.", + "tags": [ + "OpenAPI" + ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/openapi/info?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOpenApiInfo --help" + } + ] + } + }, "/api/atlas/v2/orgs": { "get": { "description": "Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role.", @@ -26429,6 +30994,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations" }, "post": { @@ -26495,6 +31072,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization" } }, @@ -26545,6 +31134,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization" }, "get": { @@ -26599,6 +31200,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization" }, "patch": { @@ -26661,6 +31274,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganization --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization" } }, @@ -26721,6 +31346,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys" }, "post": { @@ -26781,6 +31418,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/apiKeys\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey" } }, @@ -26839,6 +31488,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey" }, "get": { @@ -26901,6 +31562,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey" }, "patch": { @@ -26974,6 +31647,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey" } }, @@ -27044,6 +31729,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries" }, "post": { @@ -27128,6 +31825,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList" } }, @@ -27200,6 +31909,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry" }, "get": { @@ -27270,6 +31991,18 @@ "tags": [ "Programmatic API Keys" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList" } }, @@ -27328,6 +32061,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess" } }, @@ -27399,6 +32144,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getCostExplorerQueryProcess --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess" } }, @@ -27507,6 +32264,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents" } }, @@ -27580,6 +32349,18 @@ "tags": [ "Events" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent" } }, @@ -27633,6 +32414,18 @@ "tags": [ "Federated Authentication" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings" } }, @@ -27705,6 +32498,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects" } }, @@ -27780,6 +32585,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations" }, @@ -27845,6 +32662,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation" }, @@ -27910,6 +32739,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/invites\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation" } @@ -27972,6 +32813,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation" }, @@ -28036,6 +32889,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation" }, @@ -28111,6 +32976,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById" } @@ -28249,6 +33126,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices" } }, @@ -28296,6 +33185,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices" } }, @@ -28365,6 +33266,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice" } }, @@ -28423,6 +33336,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCsv --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv" } }, @@ -28497,6 +33422,18 @@ "tags": [ "Invoices" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api queryLineItemsFromSingleInvoice --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice" } }, @@ -28553,6 +33490,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects" } }, @@ -28597,6 +33546,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken" }, "post": { @@ -28656,6 +33617,18 @@ "tags": [ "Cloud Migration Service" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken" } }, @@ -28720,6 +33693,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getResourcesNonCompliant --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant" } }, @@ -28785,6 +33770,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasResourcePolicies --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies" }, "post": { @@ -28857,6 +33854,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/resourcePolicies\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy" } }, @@ -28921,6 +33930,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy" }, "get": { @@ -28989,6 +34010,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy" }, "patch": { @@ -29074,6 +34107,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy" } }, @@ -29148,6 +34193,18 @@ "tags": [ "Resource Policies" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api validateAtlasResourcePolicy --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy" } }, @@ -29201,6 +34258,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts" }, "post": { @@ -29260,6 +34329,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount" } }, @@ -29315,6 +34396,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount" }, "get": { @@ -29374,6 +34467,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount" }, "patch": { @@ -29444,6 +34549,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount" } }, @@ -29511,6 +34628,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList" }, "post": { @@ -29598,6 +34727,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccountAccessList --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList" } }, @@ -29667,6 +34808,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountAccessListEntry --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry" } }, @@ -29735,6 +34888,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects" } }, @@ -29807,6 +34972,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret" } }, @@ -29871,6 +35048,18 @@ "tags": [ "Service Accounts" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret" } }, @@ -29921,6 +35110,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings" }, "patch": { @@ -29980,6 +35181,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/settings\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings" } }, @@ -30043,6 +35256,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams" }, "post": { @@ -30109,6 +35334,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam" } }, @@ -30172,6 +35409,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName" } }, @@ -30233,6 +35482,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam" }, "get": { @@ -30295,6 +35556,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById" }, "patch": { @@ -30371,6 +35644,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam" } }, @@ -30462,6 +35747,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers" }, "post": { @@ -30542,6 +35839,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser" } @@ -30615,6 +35924,18 @@ "tags": [ "Teams" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser" } @@ -30691,6 +36012,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addUserToTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam" } }, @@ -30766,6 +36099,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeUserFromTeam --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam" } }, @@ -30847,6 +36192,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers" }, "post": { @@ -30909,6 +36266,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser" } }, @@ -30973,6 +36342,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X DELETE \"/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser" }, "get": { @@ -31031,6 +36412,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser" }, "patch": { @@ -31104,6 +36497,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PATCH \"/api/atlas/v2/orgs/{orgId}/users/{userId}\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser" } }, @@ -31173,6 +36578,18 @@ "tags": [ "Organizations" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X PUT \"/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles" } @@ -31252,6 +36669,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api addOrganizationRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole" } }, @@ -31327,6 +36756,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api removeOrganizationRole --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole" } }, @@ -31360,9 +36801,93 @@ "tags": [ "Root" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIpAddresses --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses" } }, + "/api/atlas/v2/unauth/openapi/versions": { + "get": { + "description": "API that provides a list of available versionsfor a given environment.", + "operationId": "getApiVersions", + "parameters": [ + { + "$ref": "#/components/parameters/envelope" + }, + { + "$ref": "#/components/parameters/itemsPerPage" + }, + { + "$ref": "#/components/parameters/pageNum" + }, + { + "$ref": "#/components/parameters/pretty" + }, + { + "description": "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com).", + "in": "query", + "name": "env", + "schema": { + "enum": [ + "dev", + "qa", + "prod", + "stage" + ], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/vnd.atlas.2024-08-05+json": { + "schema": { + "$ref": "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version": "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml": { + "schema": { + "$ref": "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version": "2024-08-05" + } + }, + "description": "OK" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Provides a list of versions for a given environment.", + "tags": [ + "OpenAPI" + ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/unauth/openapi/versions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getApiVersions --help" + } + ] + } + }, "/api/atlas/v2/users": { "post": { "deprecated": true, @@ -31416,6 +36941,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X POST \"/api/atlas/v2/users\"\n -d { }" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api createUser --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser" } @@ -31476,6 +37013,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" + } + ], "x-sunset": "2026-07-31", "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername" } @@ -31539,6 +37088,18 @@ "tags": [ "MongoDB Cloud Users" ], + "x-codeSamples": [ + { + "lang": "cURL", + "label": "curl", + "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-03-12+json\" \\\n -X GET \"/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "Atlas CLI", + "source": "atlas api getUser --help" + } + ], "x-xgen-docs-url": "https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser" } } @@ -35096,6 +40657,15 @@ "title": "API User Events", "type": "object" }, + "ApiVersion": { + "properties": { + "version": { + "description": "Object representing a version of the Atlas Admin API.", + "type": "string" + } + }, + "type": "object" + }, "AppServiceAlertConfigViewForNdsGroup": { "description": "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", "properties": { @@ -56887,6 +62457,35 @@ "type": "object", "writeOnly": true }, + "Info": { + "description": "Information about the MongoDB Atlas Administration API OpenAPI Specification.", + "properties": { + "description": { + "description": "Description of the MongoDB Atlas Administration API.", + "example": "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.", + "type": "string" + }, + "license": { + "$ref": "#/components/schemas/License" + }, + "termsOfService": { + "description": "Terms of Service URL.", + "example": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", + "type": "string" + }, + "title": { + "description": "Title of the MongoDB Atlas Administration API.", + "example": "MongoDB Atlas Administration API.", + "type": "string" + }, + "version": { + "description": "Version of the MongoDB Atlas Administration API.", + "example": "2.0", + "type": "string" + } + }, + "type": "object" + }, "IngestionPipelineRun": { "description": "Run details of a Data Lake Pipeline.", "properties": { @@ -58624,6 +64223,22 @@ ], "type": "object" }, + "License": { + "description": "License information of the MongoDB Atlas Administration API.", + "properties": { + "name": { + "description": "Name of the license.", + "example": "CC BY-NC-SA 3.0 US", + "type": "string" + }, + "url": { + "description": "URL of the license.", + "example": "https://creativecommons.org/licenses/by-nc-sa/3.0/us/", + "type": "string" + } + }, + "type": "object" + }, "Link": { "properties": { "href": { @@ -61251,6 +66866,14 @@ "title": "Online Archive Schedule", "type": "object" }, + "OpenApiInfo": { + "properties": { + "info": { + "$ref": "#/components/schemas/Info" + } + }, + "type": "object" + }, "Operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ @@ -63136,6 +68759,38 @@ }, "type": "object" }, + "PaginatedApiVersions": { + "properties": { + "links": { + "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs": { + "description": "Web Linking Specification (RFC 5988)", + "url": "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items": { + "$ref": "#/components/schemas/Link" + }, + "readOnly": true, + "type": "array" + }, + "results": { + "description": "List of returned documents that MongoDB Cloud provides when completing this request.", + "items": { + "$ref": "#/components/schemas/ApiVersion" + }, + "readOnly": true, + "type": "array" + }, + "totalCount": { + "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.", + "format": "int32", + "minimum": 0, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, "PaginatedAtlasGroupView": { "properties": { "links": { diff --git a/openapi/v2/openapi-2025-03-12.yaml b/openapi/v2/openapi-2025-03-12.yaml index 125238983e..7fa7eb3d10 100644 --- a/openapi/v2/openapi-2025-03-12.yaml +++ b/openapi/v2/openapi-2025-03-12.yaml @@ -2847,6 +2847,12 @@ components: - id title: API User Events type: object + ApiVersion: + properties: + version: + description: Object representing a version of the Atlas Admin API. + type: string + type: object AppServiceAlertConfigViewForNdsGroup: description: App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified. properties: @@ -20481,6 +20487,28 @@ components: type: object type: object writeOnly: true + Info: + description: Information about the MongoDB Atlas Administration API OpenAPI Specification. + properties: + description: + description: Description of the MongoDB Atlas Administration API. + example: The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. + type: string + license: + $ref: '#/components/schemas/License' + termsOfService: + description: Terms of Service URL. + example: https://www.mongodb.com/mongodb-management-service-terms-and-conditions + type: string + title: + description: Title of the MongoDB Atlas Administration API. + example: MongoDB Atlas Administration API. + type: string + version: + description: Version of the MongoDB Atlas Administration API. + example: "2.0" + type: string + type: object IngestionPipelineRun: description: Run details of a Data Lake Pipeline. properties: @@ -21999,6 +22027,18 @@ components: - eventTypeName - notifications type: object + License: + description: License information of the MongoDB Atlas Administration API. + properties: + name: + description: Name of the license. + example: CC BY-NC-SA 3.0 US + type: string + url: + description: URL of the license. + example: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ + type: string + type: object Link: properties: href: @@ -24146,6 +24186,11 @@ components: - type title: Online Archive Schedule type: object + OpenApiInfo: + properties: + info: + $ref: '#/components/schemas/Info' + type: object Operator: description: Comparison operator to apply when checking the current metric value. enum: @@ -25647,6 +25692,30 @@ components: readOnly: true type: integer type: object + PaginatedApiVersions: + properties: + links: + description: List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships. + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: '#/components/schemas/Link' + readOnly: true + type: array + results: + description: List of returned documents that MongoDB Cloud provides when completing this request. + items: + $ref: '#/components/schemas/ApiVersion' + readOnly: true + type: array + totalCount: + description: Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact. + format: int32 + minimum: 0 + readOnly: true + type: integer + type: object PaginatedAtlasGroupView: properties: links: @@ -34428,6 +34497,17 @@ paths: summary: Return the status of this MongoDB application tags: - Root + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/getSystemStatus /api/atlas/v2/alertConfigs/matchers/fieldNames: get: @@ -34457,6 +34537,17 @@ paths: summary: Get All Alert Configuration Matchers Field Names tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationMatchersFieldNames /api/atlas/v2/clusters: get: @@ -34485,6 +34576,17 @@ paths: summary: Return All Authorized Clusters in All Projects tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/clusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClustersForAllProjects /api/atlas/v2/eventTypes: get: @@ -34513,6 +34615,17 @@ paths: summary: List All Possible Event Types tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/eventTypes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listEventTypes /api/atlas/v2/federationSettings/{federationSettingsId}: delete: @@ -34539,6 +34652,17 @@ paths: summary: Delete One Federation Settings Instance tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteFederationApp /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: @@ -34570,6 +34694,17 @@ paths: summary: Return All Connected Org Configs from One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listConnectedOrgConfigs /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: @@ -34605,6 +34740,17 @@ paths: summary: Remove One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/removeConnectedOrgConfig get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in the connected org. @@ -34643,6 +34789,17 @@ paths: summary: Return One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getConnectedOrgConfig patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected." @@ -34686,6 +34843,18 @@ paths: summary: Update One Org Config Connected to One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateConnectedOrgConfig /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: @@ -34716,6 +34885,17 @@ paths: summary: Return All Role Mappings from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listRoleMappings post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34752,6 +34932,18 @@ paths: summary: Add One Role Mapping to One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: @@ -34788,6 +34980,17 @@ paths: summary: Remove One Role Mapping from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteRoleMapping get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34827,6 +35030,17 @@ paths: summary: Return One Role Mapping from One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getRoleMapping put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -34871,6 +35085,18 @@ paths: summary: Update One Role Mapping in One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateRoleMapping /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: @@ -34926,6 +35152,17 @@ paths: summary: Return All Identity Providers in One Federation tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/listIdentityProviders post: description: |- @@ -34964,6 +35201,18 @@ paths: summary: Create One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/createIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: @@ -35001,6 +35250,17 @@ paths: summary: Delete One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/deleteIdentityProvider get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting Service Account or API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' @@ -35038,6 +35298,17 @@ paths: summary: Return One Identity Provider by ID tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProvider patch: description: |- @@ -35083,6 +35354,18 @@ paths: summary: Update One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/updateIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: @@ -35120,6 +35403,17 @@ paths: summary: Revoke the JWKS from One OIDC Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/revokeJwksFromIdentityProvider /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: @@ -35149,6 +35443,17 @@ paths: summary: Return the Metadata of One Identity Provider tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata /api/atlas/v2/groups: get: @@ -35181,6 +35486,17 @@ paths: summary: Return All Projects tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects post: description: Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Read Write role. @@ -35224,6 +35540,18 @@ paths: summary: Create One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProject /api/atlas/v2/groups/{groupId}: delete: @@ -35254,6 +35582,17 @@ paths: summary: Remove One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProject get: description: Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, tags, and alert settings. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -35286,6 +35625,17 @@ paths: summary: Return One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProject patch: description: Updates the human-readable label that identifies the specified project, or the tags associated with the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -35322,6 +35672,18 @@ paths: summary: Update One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProject /api/atlas/v2/groups/{groupId}/access: post: @@ -35363,6 +35725,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/access" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/addUserToProject /api/atlas/v2/groups/{groupId}/accessList: @@ -35398,6 +35772,17 @@ paths: summary: Return Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help x-xgen-changelog: "2025-05-08": Corrects an issue where the endpoint would include Atlas internal entries. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/listProjectIpAccessLists @@ -35444,6 +35829,18 @@ paths: summary: Add Entries to Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/createProjectIpAccessList /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: @@ -35486,6 +35883,17 @@ paths: summary: Remove One Entry from One Project IP Access List tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/deleteProjectIpAccessList get: description: Returns one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. This endpoint (`/groups/{GROUP-ID}/accessList`) manages the Project IP Access List. It doesn't manage the access list for MongoDB Cloud organizations. TheProgrammatic API Keys endpoint (`/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist`) manages those access lists. @@ -35526,6 +35934,17 @@ paths: summary: Return One Project IP Access List Entry tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpList /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: @@ -35566,6 +35985,17 @@ paths: summary: Return Status of One Project IP Access List Entry tags: - Project IP Access List + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Project-IP-Access-List/operation/getProjectIpAccessListStatus /api/atlas/v2/groups/{groupId}/alertConfigs: get: @@ -35600,6 +36030,17 @@ paths: summary: Return All Alert Configurations for One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurations post: description: |- @@ -35639,6 +36080,18 @@ paths: summary: Create One Alert Configuration in One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/alertConfigs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: @@ -35679,6 +36132,17 @@ paths: summary: Remove One Alert Configuration from One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/deleteAlertConfiguration get: description: |- @@ -35722,6 +36186,17 @@ paths: summary: Return One Alert Configuration from One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/getAlertConfiguration patch: description: |- @@ -35772,6 +36247,18 @@ paths: summary: Toggle One State of One Alert Configuration in One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/toggleAlertConfiguration put: description: |- @@ -35824,6 +36311,18 @@ paths: summary: Update One Alert Configuration for One Project tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/updateAlertConfiguration /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: @@ -35872,6 +36371,17 @@ paths: summary: Return All Open Alerts for Alert Configuration tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlertsByAlertConfigurationId /api/atlas/v2/groups/{groupId}/alerts: get: @@ -35917,6 +36427,17 @@ paths: summary: Return All Alerts from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/listAlerts /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: @@ -35960,6 +36481,17 @@ paths: summary: Return One Alert from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/getAlert patch: description: |- @@ -36009,6 +36541,18 @@ paths: summary: Acknowledge One Alert from One Project tags: - Alerts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/alerts/{alertId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alerts/operation/acknowledgeAlert /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -36056,6 +36600,17 @@ paths: summary: Return All Alert Configurations Set for One Alert tags: - Alert Configurations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/listAlertConfigurationsByAlertId /api/atlas/v2/groups/{groupId}/apiKeys: get: @@ -36090,6 +36645,17 @@ paths: summary: Return All Organization API Keys Assigned to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listProjectApiKeys post: description: Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36124,6 +36690,18 @@ paths: summary: Create and Assign One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/apiKeys" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: @@ -36162,6 +36740,17 @@ paths: summary: Unassign One Organization API Key from One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/removeProjectApiKey patch: description: Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project. @@ -36208,6 +36797,18 @@ paths: summary: Update Roles of One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKeyRoles post: description: Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36249,6 +36850,18 @@ paths: summary: Assign One Organization API Key to One Project tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey /api/atlas/v2/groups/{groupId}/auditLog: get: @@ -36279,6 +36892,17 @@ paths: summary: Return the Auditing Configuration for One Project tags: - Auditing + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/getAuditingConfiguration patch: description: Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -36315,6 +36939,18 @@ paths: summary: Update Auditing Configuration for One Project tags: - Auditing + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/auditLog" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Auditing/operation/updateAuditingConfiguration /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: @@ -36345,6 +36981,17 @@ paths: summary: Return One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAwsCustomDns --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/getAwsCustomDns patch: description: Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -36379,6 +37026,18 @@ paths: summary: Toggle State of One Custom DNS Configuration for Atlas Clusters on AWS tags: - AWS Clusters DNS + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/awsCustomDNS" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleAwsCustomDns --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/AWS-Clusters-DNS/operation/toggleAwsCustomDns /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: @@ -36410,6 +37069,17 @@ paths: summary: Return All Snapshot Export Buckets tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listExportBuckets post: description: 'Creates a Snapshot Export Bucket for an AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket, Azure Blob Storage Container, or Google Cloud Storage Bucket. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36500,6 +37170,18 @@ paths: summary: Create One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -36535,6 +37217,17 @@ paths: summary: Delete One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteExportBucket get: description: 'Returns one Export Bucket associated with the specified Project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -36602,6 +37295,17 @@ paths: summary: Return One Snapshot Export Bucket tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getExportBucket /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: delete: @@ -36630,6 +37334,17 @@ paths: summary: Disable the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" + - label: Atlas CLI + lang: cURL + source: atlas api disableDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/disableDataProtectionSettings get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36659,6 +37374,17 @@ paths: summary: Return the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getDataProtectionSettings put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -36702,6 +37428,18 @@ paths: summary: Update or enable the Backup Compliance Policy settings tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateDataProtectionSettings /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: @@ -36734,6 +37472,17 @@ paths: summary: Return All Cloud Provider Access Roles tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/listCloudProviderAccessRoles post: description: Creates one access role for the specified cloud provider. Some MongoDB Cloud features use these cloud provider access roles for authentication. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -36771,6 +37520,18 @@ paths: summary: Create One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/cloudProviderAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/createCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: @@ -36816,6 +37577,17 @@ paths: summary: Deauthorize One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/deauthorizeCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: @@ -36853,6 +37625,17 @@ paths: summary: Return specified Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/getCloudProviderAccessRole patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting Service Account or API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. This is not required for GCP service account access. @@ -36901,6 +37684,18 @@ paths: summary: Authorize One Cloud Provider Access Role tags: - Cloud Provider Access + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Provider-Access/operation/authorizeCloudProviderAccessRole /api/atlas/v2/groups/{groupId}/clusters: get: @@ -36944,6 +37739,17 @@ paths: summary: Return All Clusters in One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters post: description: |- @@ -37072,6 +37878,18 @@ paths: summary: Create One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/createCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -37120,6 +37938,17 @@ paths: summary: Remove One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/deleteCluster get: description: |- @@ -37164,6 +37993,17 @@ paths: summary: Return One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getCluster patch: description: 'Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update clusters with asymmetrically-sized shards. To update a cluster''s termination protection, the requesting Service Account or API Key must have the Project Owner role. For all other updates, the requesting Service Account or API Key must have the Project Cluster Manager role. You can''t modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters. Deprecated versions: v2-{2024-08-05}, v2-{2023-02-01}, v2-{2023-01-01}' @@ -37210,6 +38050,18 @@ paths: summary: Modify One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -37297,6 +38149,17 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceClusterMeasurements /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: @@ -37344,6 +38207,17 @@ paths: summary: Return Ranked Namespaces from a Cluster tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForCluster /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration: get: @@ -37384,6 +38258,17 @@ paths: summary: Get cluster internal configuration of sharded cluster AutoScaling operations tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api autoScalingConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/autoScalingConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: @@ -37422,6 +38307,17 @@ paths: summary: Return All Snapshot Export Jobs tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupExportJobs post: description: Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting Service Account or API Key must have the Project Atlas Admin role. @@ -37466,6 +38362,18 @@ paths: summary: Create One Snapshot Export Job tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: @@ -37508,6 +38416,17 @@ paths: summary: Return One Snapshot Export Job tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupExportJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: @@ -37546,6 +38465,17 @@ paths: summary: Return All Restore Jobs for One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listBackupRestoreJobs post: description: |- @@ -37594,6 +38524,18 @@ paths: summary: Restore One Snapshot of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: @@ -37638,6 +38580,17 @@ paths: summary: Cancel One Restore Job of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/cancelBackupRestoreJob get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Backup Manager role. @@ -37679,6 +38632,17 @@ paths: summary: Return One Restore Job of One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: @@ -37715,6 +38679,17 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteAllBackupSchedules get: description: 'Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -37749,6 +38724,17 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getBackupSchedule patch: description: 'Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -37795,6 +38781,18 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateBackupSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -37835,6 +38833,17 @@ paths: summary: Return All Replica Set Cloud Backups tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listReplicaSetBackups post: description: |- @@ -37881,6 +38890,18 @@ paths: summary: Take One On-Demand Snapshot tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/takeSnapshot /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: @@ -37923,6 +38944,17 @@ paths: summary: Remove One Replica Set Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteReplicaSetBackup get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. @@ -37968,6 +39000,17 @@ paths: summary: Return One Replica Set Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getReplicaSetBackup patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project, the requesting Service Account or API Key must have the Project Backup Manager role. @@ -38018,6 +39061,18 @@ paths: summary: Change Expiration Date for One Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/updateSnapshotRetention /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: @@ -38058,6 +39113,17 @@ paths: summary: Remove One Sharded Cluster Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/deleteShardedClusterBackup get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role or Project Backup Manager role. @@ -38103,6 +39169,17 @@ paths: summary: Return One Sharded Cluster Cloud Backup tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getShardedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: @@ -38140,6 +39217,17 @@ paths: summary: Return All Sharded Cluster Cloud Backups tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listShardedClusterBackups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: @@ -38192,6 +39280,18 @@ paths: summary: Download One M2 or M5 Cluster Snapshot tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/downloadSharedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: @@ -38244,6 +39344,18 @@ paths: summary: Create One Restore Job from One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/createSharedClusterBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: @@ -38287,6 +39399,17 @@ paths: summary: Return All Restore Jobs for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/listSharedClusterBackupRestoreJobs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: @@ -38337,6 +39460,17 @@ paths: summary: Return One Restore Job for One M2 or M5 Cluster tags: - Shared-Tier Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Restore-Jobs/operation/getSharedClusterBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: @@ -38380,6 +39514,17 @@ paths: summary: Return All Snapshots for One M2 or M5 Cluster tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/listSharedClusterBackups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: @@ -38430,6 +39575,17 @@ paths: summary: Return One Snapshot for One M2 or M5 Cluster tags: - Shared-Tier Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Shared-Tier-Snapshots/operation/getSharedClusterBackup /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: @@ -38469,6 +39625,17 @@ paths: summary: Return All Legacy Backup Checkpoints tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupCheckpoints /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: @@ -38516,6 +39683,17 @@ paths: summary: Return One Legacy Backup Checkpoint tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupCheckpoint /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: @@ -38552,6 +39730,17 @@ paths: summary: Return Pinned Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getPinnedNamespaces patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster. @@ -38601,6 +39790,18 @@ paths: summary: Add Pinned Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPatch put: description: Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster. @@ -38650,6 +39851,18 @@ paths: summary: Pin Namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/pinNamespacesPut /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: @@ -38693,6 +39906,18 @@ paths: summary: Unpin namespaces tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/unpinNamespaces /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: @@ -38743,6 +39968,18 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndexDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: @@ -38799,6 +40036,17 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: @@ -38848,6 +40096,17 @@ paths: summary: Remove One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexDeprecated get: @@ -38896,6 +40155,17 @@ paths: summary: Return One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexDeprecated patch: @@ -38955,6 +40225,18 @@ paths: summary: Update One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help x-sunset: "2026-11-30" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexDeprecated /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: @@ -38996,6 +40278,17 @@ paths: summary: Return One Managed Namespace in One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/getManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -39034,6 +40327,17 @@ paths: summary: Remove All Custom Zone Mappings from One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteAllCustomZoneMappings post: description: 'Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting Service Account or API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -39081,6 +40385,18 @@ paths: summary: Add One Entry to One Custom Zone Mapping tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createCustomZoneMapping /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -39131,6 +40447,17 @@ paths: summary: Remove One Managed Namespace from One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/deleteManagedNamespace post: description: 'Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -39180,6 +40507,18 @@ paths: summary: Create One Managed Namespace in One Global Cluster tags: - Global Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Global-Clusters/operation/createManagedNamespace /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -39290,6 +40629,18 @@ paths: summary: Create One Rolling Index tags: - Rolling Index + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Rolling-Index/operation/createRollingIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: @@ -39331,6 +40682,17 @@ paths: summary: Return All Online Archives for One Cluster tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/listOnlineArchives post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -39379,6 +40741,18 @@ paths: summary: Create One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help x-xgen-changelog: "2023-08-02": If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive @@ -39424,6 +40798,17 @@ paths: summary: Remove One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/deleteOnlineArchive get: description: Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -39472,6 +40857,17 @@ paths: summary: Return One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/getOnlineArchive patch: description: Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -39527,6 +40923,18 @@ paths: summary: Update One Online Archive tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/updateOnlineArchive /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: @@ -39594,6 +41002,17 @@ paths: summary: Download Online Archive Query Logs tags: - Online Archive + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: @@ -39634,6 +41053,17 @@ paths: summary: End an Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/endOutageSimulation get: description: Returns one outage simulation for one cluster. @@ -39677,6 +41107,17 @@ paths: summary: Return One Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/getOutageSimulation post: description: Starts a cluster outage simulation. @@ -39723,6 +41164,18 @@ paths: summary: Start an Outage Simulation tags: - Cluster Outage Simulation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cluster-Outage-Simulation/operation/startOutageSimulation /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions: get: @@ -39758,6 +41211,17 @@ paths: summary: Returns Suggested Indexes to Drop tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDropIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listDropIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice: get: @@ -39793,6 +41257,17 @@ paths: summary: Return Schema Advice tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/schemaAdvice?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSchemaAdvice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSchemaAdvice /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: get: @@ -39871,6 +41346,17 @@ paths: summary: Return Suggested Indexes tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listClusterSuggestedIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listClusterSuggestedIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: @@ -39913,6 +41399,17 @@ paths: summary: Return One Advanced Configuration Options for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterAdvancedConfiguration patch: description: 'Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, flex clusters, or serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -39960,6 +41457,18 @@ paths: summary: Update Advanced Configuration Options for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/updateClusterAdvancedConfiguration /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -39993,6 +41502,18 @@ paths: summary: Test Failover for One Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/testFailover /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: @@ -40046,6 +41567,17 @@ paths: summary: Return All Legacy Backup Restore Jobs tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacyBackupRestoreJobs post: deprecated: true @@ -40093,6 +41625,18 @@ paths: summary: Create One Legacy Backup Restore Job tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/createLegacyBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: @@ -40147,6 +41691,17 @@ paths: summary: Return One Legacy Backup Restore Job tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacyBackupRestoreJob /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: @@ -40184,6 +41739,17 @@ paths: summary: Delete Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchDeployment get: description: 'Returns the Search Nodes for the specified cluster. Deprecated versions: v2-{2024-05-30}, v2-{2023-01-01}' @@ -40220,6 +41786,17 @@ paths: summary: Return Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help x-xgen-changelog: "2025-03-12": Updates the return of the API when no nodes exist, the endpoint returns 200 with an empty JSON ({}) instead of 400. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchDeployment @@ -40267,6 +41844,18 @@ paths: summary: Update Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchDeployment post: description: Creates Search Nodes for the specified cluster. @@ -40312,6 +41901,18 @@ paths: summary: Create Search Nodes tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchDeployment /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: @@ -40362,6 +41963,17 @@ paths: summary: Return All Atlas Search Indexes for One Cluster tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexesCluster post: description: Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40410,6 +42022,18 @@ paths: summary: Create One Atlas Search Index tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/createAtlasSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: @@ -40472,6 +42096,17 @@ paths: summary: Return All Atlas Search Indexes for One Collection tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/listAtlasSearchIndexes /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: @@ -40528,6 +42163,17 @@ paths: summary: Remove One Atlas Search Index by Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndexByName get: description: Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. @@ -40585,6 +42231,17 @@ paths: summary: Return One Atlas Search Index by Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndexByName patch: description: Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40651,6 +42308,18 @@ paths: summary: Update One Atlas Search Index By Name tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndexByName /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: @@ -40698,6 +42367,17 @@ paths: summary: Remove One Atlas Search Index by Id tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/deleteAtlasSearchIndex get: description: Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Write role. @@ -40752,6 +42432,17 @@ paths: summary: Return One Atlas Search Index by ID tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/getAtlasSearchIndex patch: description: Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role. @@ -40809,6 +42500,18 @@ paths: summary: Update One Atlas Search Index By ID tags: - Atlas Search + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndex --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Atlas-Search/operation/updateAtlasSearchIndex /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -40853,6 +42556,17 @@ paths: summary: Return One Snapshot Schedule tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshotSchedule patch: deprecated: true @@ -40903,6 +42617,18 @@ paths: summary: Update Snapshot Schedule for One Cluster tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotSchedule /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: @@ -40955,6 +42681,17 @@ paths: summary: Return All Legacy Backup Snapshots tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/listLegacySnapshots /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: @@ -41001,6 +42738,17 @@ paths: summary: Remove One Legacy Backup Snapshot tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/deleteLegacySnapshot get: deprecated: true @@ -41048,6 +42796,17 @@ paths: summary: Return One Legacy Backup Snapshot tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/getLegacySnapshot patch: deprecated: true @@ -41100,6 +42859,18 @@ paths: summary: Change One Legacy Backup Snapshot Expiration tags: - Legacy Backup + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Legacy-Backup/operation/updateLegacySnapshotRetention /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: @@ -41137,6 +42908,17 @@ paths: summary: Return Status of All Cluster Operations tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getClusterStatus /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: post: @@ -41182,6 +42964,18 @@ paths: summary: Grant MongoDB employee cluster access for one cluster. tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api grantMongoDbEmployeeAccess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/grantMongoDbEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: @@ -41226,6 +43020,18 @@ paths: summary: Pin FCV for One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pinFeatureCompatibilityVersion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/pinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: post: @@ -41263,6 +43069,18 @@ paths: summary: Revoke granted MongoDB employee cluster access for one cluster. tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api revokeMongoDbEmployeeAccess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/revokeMongoDbEmployeeAccess /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: @@ -41302,6 +43120,18 @@ paths: summary: Unpins FCV for One Cluster from One Project tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api unpinFeatureCompatibilityVersion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/unpinFeatureCompatibilityVersion /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: @@ -41370,6 +43200,17 @@ paths: summary: Download Logs for One Cluster Host in One Project tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostLogs /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: @@ -41413,6 +43254,17 @@ paths: summary: Return All Cloud Provider Regions tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listCloudProviderRegions /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: @@ -41457,6 +43309,18 @@ paths: summary: Upgrade One Shared-tier Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedCluster /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: @@ -41505,6 +43369,18 @@ paths: summary: Upgrades One Shared-Tier Cluster to the Serverless Instance tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help x-sunset: "2025-02-05" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/upgradeSharedClusterToServerless /api/atlas/v2/groups/{groupId}/collStats/metrics: @@ -41533,6 +43409,17 @@ paths: summary: Return all metric names tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceMetrics /api/atlas/v2/groups/{groupId}/containers: get: @@ -41577,6 +43464,17 @@ paths: summary: Return All Network Peering Containers in One Project for One Cloud Provider tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainerByCloudProvider post: description: Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -41615,6 +43513,18 @@ paths: summary: Create One New Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/containers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringContainer /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: @@ -41653,6 +43563,17 @@ paths: summary: Remove One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/containers/{containerId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringContainer get: description: Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -41690,6 +43611,17 @@ paths: summary: Return One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringContainer patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -41736,6 +43668,18 @@ paths: summary: Update One Network Peering Container tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/containers/{containerId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringContainer /api/atlas/v2/groups/{groupId}/containers/all: get: @@ -41767,6 +43711,17 @@ paths: summary: Return All Network Peering Containers in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringContainers /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: @@ -41799,6 +43754,17 @@ paths: summary: Return All Custom Roles in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/listCustomDatabaseRoles post: description: Creates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -41837,6 +43803,18 @@ paths: summary: Create One Custom Role tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/customDBRoles/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/createCustomDatabaseRole /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: @@ -41873,6 +43851,17 @@ paths: summary: Remove One Custom Role from One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/deleteCustomDatabaseRole get: description: Returns one custom role for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -41906,6 +43895,17 @@ paths: summary: Return One Custom Role in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/getCustomDatabaseRole patch: description: Updates one custom role in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -41950,6 +43950,18 @@ paths: summary: Update One Custom Role in One Project tags: - Custom Database Roles + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Custom-Database-Roles/operation/updateCustomDatabaseRole /api/atlas/v2/groups/{groupId}/dataFederation: get: @@ -41995,6 +44007,17 @@ paths: summary: Return All Federated Database Instances in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listFederatedDatabases post: description: Creates one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or Project Charts Admin roles. @@ -42037,6 +44060,18 @@ paths: summary: Create One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/dataFederation" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createFederatedDatabase /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: @@ -42069,6 +44104,17 @@ paths: summary: Remove One Federated Database Instance from One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteFederatedDatabase get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -42106,6 +44152,17 @@ paths: summary: Return One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getFederatedDatabase patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner or higher role. @@ -42154,6 +44211,18 @@ paths: summary: Update One Federated Database Instance in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/updateFederatedDatabase /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: @@ -42196,6 +44265,17 @@ paths: summary: Return All Query Limits for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimits /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: @@ -42248,6 +44328,17 @@ paths: summary: Delete One Query Limit For One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteOneDataFederationInstanceQueryLimit get: description: Returns the details of one query limit for the specified federated database instance in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -42302,6 +44393,17 @@ paths: summary: Return One Federated Database Instance Query Limit for One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/returnFederatedDatabaseQueryLimit patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -42362,6 +44464,18 @@ paths: summary: Configure One Query Limit for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createOneDataFederationQueryLimit /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: @@ -42416,6 +44530,17 @@ paths: summary: Download Query Logs for One Federated Database Instance tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs /api/atlas/v2/groups/{groupId}/databaseUsers: get: @@ -42447,6 +44572,17 @@ paths: summary: Return All Database Users from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/listDatabaseUsers post: description: Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting Service Account or API Key must have the Project Owner role, the Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -42579,6 +44715,18 @@ paths: summary: Create One Database User in One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/databaseUsers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: @@ -42635,6 +44783,17 @@ paths: summary: Remove One Database User from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/deleteDatabaseUser get: description: Returns one database user that belong to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -42692,6 +44851,17 @@ paths: summary: Return One Database User from One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role, Project Charts Admin role, Project Stream Processing Owner role, or the Project Database Access Admin role. @@ -42760,6 +44930,18 @@ paths: summary: Update One Database User in One Project tags: - Database Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/updateDatabaseUser /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: @@ -42799,6 +44981,17 @@ paths: summary: Return All X.509 Certificates Assigned to One MongoDB User tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/listDatabaseUserCertificates post: description: |- @@ -42852,6 +45045,18 @@ paths: summary: Create One X.509 Certificate for One MongoDB User tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/createDatabaseUserCertificate /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: @@ -42924,6 +45129,17 @@ paths: summary: Return Database Access History for One Cluster using Its Cluster Name tags: - Access Tracking + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByClusterName /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: @@ -42993,6 +45209,17 @@ paths: summary: Return Database Access History for One Cluster using Its Hostname tags: - Access Tracking + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Access-Tracking/operation/listAccessLogsByHostname /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: @@ -43027,6 +45254,17 @@ paths: summary: Return One Configuration for Encryption at Rest using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRest patch: description: |- @@ -43077,6 +45315,18 @@ paths: summary: Update Configuration for Encryption at Rest using Customer-Managed Keys for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/encryptionAtRest" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: @@ -43117,6 +45367,17 @@ paths: summary: Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpointsForCloudProvider post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. @@ -43160,6 +45421,18 @@ paths: summary: Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/createEncryptionAtRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: @@ -43202,6 +45475,17 @@ paths: summary: Delete Private Endpoint for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/requestEncryptionAtRestPrivateEndpointDeletion get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -43247,6 +45531,17 @@ paths: summary: Return One Private Endpoint for Encryption at Rest Using Customer Key Management tags: - Encryption at Rest using Customer Key Management + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Encryption-at-Rest-using-Customer-Key-Management/operation/getEncryptionAtRestPrivateEndpoint /api/atlas/v2/groups/{groupId}/events: get: @@ -43338,6 +45633,17 @@ paths: summary: Return All Events from One Project tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/events?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listProjectEvents /api/atlas/v2/groups/{groupId}/events/{eventId}: get: @@ -43387,6 +45693,17 @@ paths: summary: Return One Event from One Project tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getProjectEvent /api/atlas/v2/groups/{groupId}/flexClusters: get: @@ -43420,6 +45737,17 @@ paths: summary: Return All Flex Clusters from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexClusters --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/listFlexClusters post: description: Creates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43460,6 +45788,18 @@ paths: summary: Create One Flex Cluster in One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/createFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}: delete: @@ -43497,6 +45837,17 @@ paths: summary: Remove One Flex Cluster from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/deleteFlexCluster get: description: Returns details for one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -43537,6 +45888,17 @@ paths: summary: Return One Flex Cluster from One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/getFlexCluster patch: description: Updates one flex cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43582,6 +45944,18 @@ paths: summary: Update One Flex Cluster in One Project tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/updateFlexCluster /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download: post: @@ -43628,6 +46002,18 @@ paths: summary: Download One Flex Cluster Snapshot tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api downloadFlexBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/downloadFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs: get: @@ -43668,6 +46054,17 @@ paths: summary: Return All Restore Jobs for One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/listFlexBackupRestoreJobs post: description: Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -43713,6 +46110,18 @@ paths: summary: Restore One Snapshot of One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createFlexBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/createFlexBackupRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}: get: @@ -43757,6 +46166,17 @@ paths: summary: Return One Restore Job for One Flex Cluster tags: - Flex Restore Jobs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Restore-Jobs/operation/getFlexBackupRestoreJob /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots: get: @@ -43797,6 +46217,17 @@ paths: summary: Return All Snapshots of One Flex Cluster tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listFlexBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/listFlexBackups /api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}: get: @@ -43841,6 +46272,17 @@ paths: summary: Return One Snapshot of One Flex Cluster tags: - Flex Snapshots + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFlexBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Snapshots/operation/getFlexBackup /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: post: @@ -43882,6 +46324,18 @@ paths: summary: Upgrade One Flex Cluster tags: - Flex Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api upgradeFlexCluster --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters/operation/upgradeFlexCluster /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: @@ -43912,6 +46366,17 @@ paths: summary: Return All Atlas Search Metric Types for One Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listMetricTypes /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: @@ -43974,6 +46439,17 @@ paths: summary: Return Atlas Search Metrics for One Index in One Specified Namespace tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getIndexMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: @@ -44035,6 +46511,17 @@ paths: summary: Return All Atlas Search Index Metrics for One Namespace tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listIndexMetrics /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: @@ -44093,6 +46580,17 @@ paths: summary: Return Atlas Search Hardware and Status Metrics tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getMeasurements /api/atlas/v2/groups/{groupId}/integrations: get: @@ -44126,6 +46624,17 @@ paths: summary: Return All Active Third-Party Service Integrations tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/integrations?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/listThirdPartyIntegrations /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: @@ -44172,6 +46681,17 @@ paths: summary: Remove One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/deleteThirdPartyIntegration get: description: Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44221,6 +46741,17 @@ paths: summary: Return One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/getThirdPartyIntegration post: description: Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. Each project can have only one configuration per `{INTEGRATION-TYPE}`. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44280,6 +46811,18 @@ paths: summary: Configure One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/createThirdPartyIntegration put: description: Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting Service Account or API Key must have the Organization Owner or Project Owner role. @@ -44339,6 +46882,18 @@ paths: summary: Update One Third-Party Service Integration tags: - Third-Party Integrations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Third-Party-Integrations/operation/updateThirdPartyIntegration /api/atlas/v2/groups/{groupId}/invites: get: @@ -44382,6 +46937,17 @@ paths: summary: Return All Project Invitations tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/invites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectInvitations patch: @@ -44420,6 +46986,18 @@ paths: summary: Update One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitation post: @@ -44456,6 +47034,18 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/createProjectInvitation /api/atlas/v2/groups/{groupId}/invites/{invitationId}: @@ -44490,6 +47080,17 @@ paths: summary: Cancel One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectInvitation get: @@ -44528,6 +47129,17 @@ paths: summary: Return One Project Invitation tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectInvitation patch: @@ -44572,6 +47184,18 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectInvitationById /api/atlas/v2/groups/{groupId}/ipAddresses: @@ -44603,6 +47227,17 @@ paths: summary: Return All IP Addresses for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIpAddresses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/returnAllIpAddresses /api/atlas/v2/groups/{groupId}/limits: get: @@ -44643,6 +47278,17 @@ paths: summary: Return All Limits for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/limits?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjectLimits /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: @@ -44711,6 +47357,17 @@ paths: summary: Remove One Project Limit tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/limits/{limitName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/deleteProjectLimit get: description: Returns the specified limit for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -44782,6 +47439,17 @@ paths: summary: Return One Limit for One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLimit patch: description: |- @@ -44861,6 +47529,18 @@ paths: summary: Set One Project Limit tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/limits/{limitName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/setProjectLimit /api/atlas/v2/groups/{groupId}/liveMigrations: post: @@ -44909,6 +47589,18 @@ paths: summary: Migrate One Local Managed Cluster to MongoDB Atlas tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/liveMigrations" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createPushMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -44938,6 +47630,17 @@ paths: summary: Return One Migration Job tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getPushMigration /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: @@ -44967,6 +47670,18 @@ paths: summary: Cut Over the Migrated Cluster tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/cutoverMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: @@ -45005,6 +47720,18 @@ paths: summary: Validate One Migration Request tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/liveMigrations/validate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/validateMigration /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -45042,6 +47769,17 @@ paths: summary: Return One Migration Validation Job tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/getValidationStatus /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: @@ -45069,6 +47807,17 @@ paths: summary: Reset One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/maintenanceWindow" + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/resetMaintenanceWindow get: description: Returns the maintenance window for the specified project. MongoDB Cloud starts those maintenance activities when needed. You can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45098,6 +47847,17 @@ paths: summary: Return One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/getMaintenanceWindow patch: description: Updates the maintenance window for the specified project. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. Updating the maintenance window will reset any maintenance deferrals for this project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45131,6 +47891,18 @@ paths: summary: Update Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/maintenanceWindow" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/updateMaintenanceWindow /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: @@ -45158,6 +47930,18 @@ paths: summary: Toggle Automatic Deferral of Maintenance for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/toggleMaintenanceAutoDefer /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: @@ -45185,6 +47969,18 @@ paths: summary: Defer One Maintenance Window for One Project tags: - Maintenance Windows + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Maintenance-Windows/operation/deferMaintenanceWindow /api/atlas/v2/groups/{groupId}/managedSlowMs: get: @@ -45215,6 +48011,17 @@ paths: summary: Return Managed Slow MS enabled tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getManagedSlowMs /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: @@ -45241,6 +48048,17 @@ paths: summary: Disable Managed Slow Operation Threshold tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/disableSlowOperationThresholding /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: @@ -45267,6 +48085,18 @@ paths: summary: Enable Managed Slow Operation Threshold tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/enableSlowOperationThresholding /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: @@ -45335,6 +48165,17 @@ paths: summary: Return Available MongoDB LTS Versions for clusters in One Project tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLtsVersions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions /api/atlas/v2/groups/{groupId}/peers: get: @@ -45380,6 +48221,17 @@ paths: summary: Return All Network Peering Connections in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/peers?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/listPeeringConnections post: description: Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. @@ -45421,6 +48273,18 @@ paths: summary: Create One New Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/peers" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/createPeeringConnection /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: @@ -45458,6 +48322,17 @@ paths: summary: Remove One Existing Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/peers/{peerId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/deletePeeringConnection get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -45496,6 +48371,17 @@ paths: summary: Return One Network Peering Connection in One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/getPeeringConnection patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -45541,6 +48427,18 @@ paths: summary: Update One New Network Peering Connection tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/peers/{peerId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/updatePeeringConnection /api/atlas/v2/groups/{groupId}/pipelines: get: @@ -45579,6 +48477,17 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelines post: @@ -45619,6 +48528,18 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/createPipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: @@ -45653,6 +48574,17 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipeline get: @@ -45693,6 +48625,17 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipeline patch: @@ -45739,6 +48682,18 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/updatePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: @@ -45785,6 +48740,17 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSchedules /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: @@ -45836,6 +48802,17 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineSnapshots /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: @@ -45875,6 +48852,18 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/pausePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: @@ -45914,6 +48903,18 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/resumePipeline /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: @@ -45964,6 +48965,17 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/listPipelineRuns /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: @@ -46011,6 +49023,17 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/deletePipelineRunDataset get: @@ -46059,6 +49082,17 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/getPipelineRun /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: @@ -46105,6 +49139,18 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help x-sunset: "2025-09-09" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Lake-Pipelines/operation/triggerSnapshotIngestion /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: @@ -46157,6 +49203,17 @@ paths: summary: Return All Private Endpoint Services for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/listPrivateEndpointServices /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: @@ -46205,6 +49262,17 @@ paths: summary: Remove One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpointService get: description: Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -46256,6 +49324,17 @@ paths: summary: Return One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: @@ -46317,6 +49396,18 @@ paths: summary: Create One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: @@ -46372,6 +49463,17 @@ paths: summary: Remove One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/deletePrivateEndpoint get: description: Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role. @@ -46430,6 +49532,17 @@ paths: summary: Return One Private Endpoint for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: @@ -46470,6 +49583,18 @@ paths: summary: Create One Private Endpoint Service for One Provider tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/createPrivateEndpointService /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: @@ -46498,6 +49623,17 @@ paths: summary: Return Regionalized Private Endpoint Status tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/getRegionalizedPrivateEndpointSetting patch: description: Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner role and all clusters in the deployment must be sharded clusters. Once enabled, you cannot create replica sets. @@ -46534,6 +49670,18 @@ paths: summary: Toggle Regionalized Private Endpoint Status tags: - Private Endpoint Services + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Private-Endpoint-Services/operation/toggleRegionalizedPrivateEndpointSetting /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: @@ -46581,6 +49729,17 @@ paths: summary: Return All Private Endpoints for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/listServerlessPrivateEndpoints post: description: |- @@ -46631,6 +49790,18 @@ paths: summary: Create One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/createServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: @@ -46675,6 +49846,17 @@ paths: summary: Remove One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/deleteServerlessPrivateEndpoint get: description: |- @@ -46722,6 +49904,17 @@ paths: summary: Return One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/getServerlessPrivateEndpoint patch: description: |- @@ -46774,6 +49967,18 @@ paths: summary: Update One Private Endpoint for One Serverless Instance tags: - Serverless Private Endpoints + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Private-Endpoints/operation/updateServerlessPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateIpMode: get: @@ -46808,6 +50013,17 @@ paths: summary: Verify Connect via Peering Only Mode for One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/verifyConnectViaPeeringOnlyModeForOneProject patch: deprecated: true @@ -46848,6 +50064,18 @@ paths: summary: Disable Connect via Peering Only Mode for One Project tags: - Network Peering + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/privateIpMode" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Network-Peering/operation/disablePeering /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: @@ -46881,6 +50109,17 @@ paths: summary: Return All Federated Database Instance and Online Archive Private Endpoints in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/listDataFederationPrivateEndpoints post: description: |- @@ -46936,6 +50175,18 @@ paths: summary: Create One Federated Database Instance and Online Archive Private Endpoint for One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/createDataFederationPrivateEndpoint /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: @@ -46969,6 +50220,17 @@ paths: summary: Remove One Federated Database Instance and Online Archive Private Endpoint from One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/deleteDataFederationPrivateEndpoint get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only or Project Charts Admin roles. @@ -47005,6 +50267,17 @@ paths: summary: Return One Federated Database Instance and Online Archive Private Endpoint in One Project tags: - Data Federation + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/getDataFederationPrivateEndpoint /api/atlas/v2/groups/{groupId}/processes: get: @@ -47036,6 +50309,17 @@ paths: summary: Return All MongoDB Processes in One Project tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listAtlasProcesses /api/atlas/v2/groups/{groupId}/processes/{processId}: get: @@ -47074,6 +50358,17 @@ paths: summary: Return One MongoDB Process by ID tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getAtlasProcess /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -47143,6 +50438,17 @@ paths: summary: Return Host-Level Query Latency tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespaceHostMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: @@ -47174,6 +50480,17 @@ paths: summary: Return Ranked Namespaces from a Host tags: - Collection Level Metrics + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Collection-Level-Metrics/operation/getCollStatsLatencyNamespacesForHost /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: @@ -47216,6 +50533,17 @@ paths: summary: Return Available Databases for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDatabases /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: @@ -47260,6 +50588,17 @@ paths: summary: Return One Database for a MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabase /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: @@ -47330,6 +50669,17 @@ paths: summary: Return Measurements of One Database for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDatabaseMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: @@ -47369,6 +50719,17 @@ paths: summary: Return Available Disks for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskPartitions /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: @@ -47412,6 +50773,17 @@ paths: summary: Return Measurements of One Disk tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/listDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: @@ -47501,6 +50873,17 @@ paths: summary: Return Measurements of One Disk for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getDiskMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: @@ -47703,6 +51086,17 @@ paths: summary: Return Measurements for One MongoDB Process tags: - Monitoring and Logs + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs/operation/getHostMeasurements /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: @@ -47761,6 +51155,17 @@ paths: summary: Return All Namespaces for One Host tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueryNamespaces /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: @@ -47854,6 +51259,17 @@ paths: summary: Return Slow Queries tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSlowQueries /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: @@ -47936,6 +51352,17 @@ paths: summary: Return Suggested Indexes tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/listSuggestedIndexes /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: @@ -47964,6 +51391,17 @@ paths: summary: Disable the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/deletePushBasedLogConfiguration get: description: Fetches the current project level settings for the push-based log export feature. @@ -47994,6 +51432,17 @@ paths: summary: Get the push-based log export configuration for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/getPushBasedLogConfiguration patch: description: Updates the project level settings for the push-based log export feature. @@ -48029,6 +51478,18 @@ paths: summary: Update the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/updatePushBasedLogConfiguration post: description: Configures the project level settings for the push-based log export feature. @@ -48064,6 +51525,18 @@ paths: summary: Enable the push-based log export feature for a project tags: - Push-Based Log Export + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Push-Based-Log-Export/operation/createPushBasedLogConfiguration /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: @@ -48102,6 +51575,18 @@ paths: summary: Load Sample Dataset Request into Cluster tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/loadSampleDataset /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: @@ -48138,6 +51623,17 @@ paths: summary: Check Status of Cluster Sample Dataset Request tags: - Clusters + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/getSampleDatasetLoadStatus /api/atlas/v2/groups/{groupId}/serverless: get: @@ -48177,6 +51673,17 @@ paths: summary: Return All Serverless Instances from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/listServerlessInstances post: description: |- @@ -48223,6 +51730,18 @@ paths: summary: Create One Serverless Instance in One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/createServerlessInstance /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: @@ -48269,6 +51788,17 @@ paths: summary: Return All Restore Jobs for One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackupRestoreJobs post: description: |- @@ -48320,6 +51850,18 @@ paths: summary: Restore One Snapshot of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createServerlessBackupRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: @@ -48372,6 +51914,17 @@ paths: summary: Return One Restore Job for One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackupRestoreJob /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: @@ -48418,6 +51971,17 @@ paths: summary: Return All Snapshots of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/listServerlessBackups /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: @@ -48470,6 +52034,17 @@ paths: summary: Return One Snapshot of One Serverless Instance tags: - Cloud Backups + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/getServerlessBackup /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: @@ -48508,6 +52083,17 @@ paths: summary: Return Serverless Auto Indexing Enabled tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/getServerlessAutoIndexing post: description: Set whether the Serverless Auto Indexing feature is enabled. This endpoint sets a value for Flex clusters that were created with the createServerlessInstance endpoint or Flex clusters that were migrated from Serverless instances. However, the value returned is not indicative of the Auto Indexing state as Auto Indexing is unavailable for Flex clusters. This endpoint will be sunset in January 2026. @@ -48548,6 +52134,18 @@ paths: summary: Set Serverless Auto Indexing tags: - Performance Advisor + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Performance-Advisor/operation/setServerlessAutoIndexing /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: @@ -48593,6 +52191,17 @@ paths: summary: Remove One Serverless Instance from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serverless/{name}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/deleteServerlessInstance get: description: |- @@ -48639,6 +52248,17 @@ paths: summary: Return One Serverless Instance from One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/getServerlessInstance patch: description: |- @@ -48690,6 +52310,18 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/serverless/{name}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Serverless-Instances/operation/updateServerlessInstance /api/atlas/v2/groups/{groupId}/serviceAccounts: get: @@ -48720,6 +52352,17 @@ paths: summary: List All Project Service Accounts tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccounts post: description: Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. @@ -48757,6 +52400,18 @@ paths: summary: Create and Assign one Service Account to one Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: @@ -48792,6 +52447,17 @@ paths: summary: Unassign One Service Account from One Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccount get: description: Returns one Service Account in the specified Project. @@ -48829,6 +52495,17 @@ paths: summary: Get one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getProjectServiceAccount patch: description: Updates one Service Account in the specified Project. @@ -48873,6 +52550,18 @@ paths: summary: Update one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateProjectServiceAccount /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: get: @@ -48912,6 +52601,17 @@ paths: summary: Return All Access List entries for one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listProjectServiceAccountAccessList post: description: Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. @@ -48965,6 +52665,18 @@ paths: summary: Add Access List entries for one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountAccessList /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: @@ -49009,6 +52721,17 @@ paths: summary: Remove One Access List entry from one Project Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccountAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountAccessListEntry /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets: post: @@ -49054,6 +52777,18 @@ paths: summary: Create one Project Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createProjectServiceAccountSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: @@ -49094,6 +52829,17 @@ paths: summary: Delete one Project Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/secrets/{secretId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteProjectServiceAccountSecret /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: post: @@ -49138,6 +52884,18 @@ paths: summary: Assign One Service Account to One Project tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/addProjectServiceAccount /api/atlas/v2/groups/{groupId}/settings: get: @@ -49168,6 +52926,17 @@ paths: summary: Return One Project Settings tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/settings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectSettings patch: description: Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -49202,6 +52971,18 @@ paths: summary: Update One Project Settings tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/settings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectSettings /api/atlas/v2/groups/{groupId}/streams: get: @@ -49232,6 +53013,17 @@ paths: summary: Return All Project Stream Instances tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamInstances @@ -49270,6 +53062,18 @@ paths: summary: Create One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstance @@ -49304,6 +53108,17 @@ paths: summary: Delete One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamInstance @@ -49347,6 +53162,17 @@ paths: summary: Return One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamInstance @@ -49391,6 +53217,18 @@ paths: summary: Update One Stream Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamInstance @@ -49448,6 +53286,17 @@ paths: summary: Download Audit Logs for One Atlas Stream Processing Instance tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/downloadStreamTenantAuditLogs /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: @@ -49484,6 +53333,17 @@ paths: summary: Return All Connections Of The Stream Instances tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamConnections @@ -49530,6 +53390,18 @@ paths: summary: Create One Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamConnection @@ -49572,6 +53444,17 @@ paths: summary: Delete One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamConnection @@ -49614,6 +53497,17 @@ paths: summary: Return One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamConnection @@ -49666,6 +53560,18 @@ paths: summary: Update One Stream Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help x-xgen-changelog: "2023-09-11": The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/updateStreamConnection @@ -49713,6 +53619,18 @@ paths: summary: Create One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: @@ -49751,6 +53669,17 @@ paths: summary: Delete One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteStreamProcessor get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -49794,6 +53723,17 @@ paths: summary: Get One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getStreamProcessor patch: description: Modify one existing Stream Processor within the specified stream instance. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -49842,6 +53782,18 @@ paths: summary: Modify One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api modifyStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/modifyStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: @@ -49880,6 +53832,18 @@ paths: summary: Start One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith: post: @@ -49925,6 +53889,18 @@ paths: summary: Start One Stream Processor With Options tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:startWith" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessorWith --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/startStreamProcessorWith /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: @@ -49963,6 +53939,18 @@ paths: summary: Stop One Stream Processor tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api stopStreamProcessor --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/stopStreamProcessor /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: @@ -50005,6 +53993,17 @@ paths: summary: Return All Stream Processors In The Stream Instance. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listStreamProcessors --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listStreamProcessors /api/atlas/v2/groups/{groupId}/streams/accountDetails: get: @@ -50044,6 +54043,17 @@ paths: summary: Returns the Account ID, and the VPC ID for the group and region specified. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/accountDetails?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAccountDetails --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getAccountDetails /api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections: get: @@ -50072,6 +54082,17 @@ paths: summary: Returns all the active incoming VPC Peering Connections. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/activeVpcPeeringConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getActiveVpcPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getActiveVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: get: @@ -50102,6 +54123,17 @@ paths: summary: Return All Private Link tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateLinkConnections --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/listPrivateLinkConnections @@ -50142,6 +54174,18 @@ paths: summary: Create One Private Link connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createPrivateLinkConnection @@ -50176,6 +54220,17 @@ paths: summary: Delete One Private Link connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deletePrivateLinkConnection @@ -50210,6 +54265,17 @@ paths: summary: Return One PrivateLink Connection tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateLinkConnection --help x-xgen-changelog: "2024-10-02": The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA. x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getPrivateLinkConnection @@ -50246,6 +54312,17 @@ paths: summary: Return All VPC Peering Connections. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getVpcPeeringConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/getVpcPeeringConnections /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: delete: @@ -50277,6 +54354,17 @@ paths: summary: Deletes an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/deleteVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: post: @@ -50315,6 +54403,18 @@ paths: summary: Requests the acceptance of an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api acceptVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/acceptVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: post: @@ -50346,6 +54446,18 @@ paths: summary: Requests the rejection of an incoming VPC Peering connection. tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api rejectVpcPeeringConnection --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/rejectVpcPeeringConnection /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: post: @@ -50383,6 +54495,18 @@ paths: summary: Create One Stream Instance With Sample Connections tags: - Streams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstanceWithSampleConnections --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Streams/operation/createStreamInstanceWithSampleConnections /api/atlas/v2/groups/{groupId}/teams: get: @@ -50416,6 +54540,17 @@ paths: summary: Return All Teams in One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/teams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listProjectTeams post: description: Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -50457,6 +54592,18 @@ paths: summary: Add One or More Teams to One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/teams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addAllTeamsToProject /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: @@ -50494,6 +54641,17 @@ paths: summary: Remove One Team from One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/teams/{teamId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeProjectTeam patch: description: Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting Service Account or API Key must have the Project Owner role. @@ -50540,6 +54698,18 @@ paths: summary: Update Team Roles in One Project tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/teams/{teamId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/updateTeamRoles /api/atlas/v2/groups/{groupId}/userSecurity: get: @@ -50571,6 +54741,17 @@ paths: summary: Return the Current LDAP or X.509 Configuration tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfiguration patch: description: |- @@ -50610,6 +54791,18 @@ paths: summary: Edit the LDAP or X.509 Configuration tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/groups/{groupId}/userSecurity" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api saveLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/saveLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: @@ -50640,6 +54833,17 @@ paths: summary: Disable Customer-Managed X.509 tags: - X.509 Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/X.509-Authentication/operation/disableCustomerManagedX509 /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: @@ -50668,6 +54872,17 @@ paths: summary: Remove the Current LDAP User to DN Mapping tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/deleteLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: @@ -50705,6 +54920,18 @@ paths: summary: Verify the LDAP Configuration in One Project tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api verifyLdapConfiguration --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/verifyLdapConfiguration /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: @@ -50740,6 +54967,17 @@ paths: summary: Return the Status of One Verify LDAP Configuration Request tags: - LDAP Configuration + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getLdapConfigurationStatus --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/LDAP-Configuration/operation/getLdapConfigurationStatus /api/atlas/v2/groups/{groupId}/users: get: @@ -50803,6 +55041,17 @@ paths: summary: Return All MongoDB Cloud Users in One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listProjectUsers post: description: "Adds one MongoDB Cloud user to one project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. \n- If the user has a pending invitation to join the project's organization, MongoDB Cloud modifies it and grants project access. \n- If the user doesn't have an invitation to join the organization, MongoDB Cloud sends a new invitation that grants the user organization and project access. \n- If the user is already active in the project's organization, MongoDB Cloud grants access to the project. \n" @@ -50841,6 +55090,18 @@ paths: summary: Add One MongoDB Cloud User to One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectUser /api/atlas/v2/groups/{groupId}/users/{userId}: delete: @@ -50886,6 +55147,17 @@ paths: summary: Remove One MongoDB Cloud User from One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/groups/{groupId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectUser get: description: |- @@ -50927,6 +55199,17 @@ paths: summary: Return One MongoDB Cloud User in One Project tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/{groupId}/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getProjectUser /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: @@ -50970,6 +55253,18 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/groups/{groupId}/users/{userId}/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/updateProjectRoles /api/atlas/v2/groups/{groupId}/users/{userId}:addRole: @@ -51023,6 +55318,18 @@ paths: summary: Add One Project Role to One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users/{userId}:addRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addProjectRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addProjectRole /api/atlas/v2/groups/{groupId}/users/{userId}:removeRole: post: @@ -51075,6 +55382,18 @@ paths: summary: Remove One Project Role from One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}/users/{userId}:removeRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeProjectRole /api/atlas/v2/groups/{groupId}:migrate: post: @@ -51109,6 +55428,18 @@ paths: summary: Migrate One Project to Another Organization tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/groups/{groupId}:migrate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api migrateProjectToAnotherOrg --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/migrateProjectToAnotherOrg /api/atlas/v2/groups/byName/{groupName}: get: @@ -51148,7 +55479,52 @@ paths: summary: Return One Project using Its Name tags: - Projects + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/groups/byName/{groupName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectByName + /api/atlas/v2/openapi/info: + get: + description: 'This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification. Deprecated versions: v2-{2024-05-30}' + operationId: getOpenApiInfo + parameters: + - $ref: '#/components/parameters/pretty' + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: '#/components/schemas/OpenApiInfo' + x-xgen-version: "2024-08-05" + description: OK + "401": + $ref: '#/components/responses/unauthorized' + "403": + $ref: '#/components/responses/forbidden' + "500": + $ref: '#/components/responses/internalServerError' + summary: Return general information about the MongoDB Atlas Administration API OpenAPI Specification. + tags: + - OpenAPI + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/openapi/info?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOpenApiInfo --help /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51187,6 +55563,17 @@ paths: summary: Return All Organizations tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizations post: description: Creates one organization in MongoDB Cloud and links it to the requesting Service Account's or API Key's organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. The requesting Service Account's or API Key's organization must be a paying organization. To learn more, see Configure a Paying Organization in the MongoDB Atlas documentation. @@ -51229,6 +55616,18 @@ paths: summary: Create One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganization /api/atlas/v2/orgs/{orgId}: delete: @@ -51265,6 +55664,17 @@ paths: summary: Remove One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganization get: description: Returns one organization to which the requesting Service Account or API Key has access. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51298,6 +55708,17 @@ paths: summary: Return One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganization patch: description: Updates one organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -51336,6 +55757,18 @@ paths: summary: Update One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganization --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganization /api/atlas/v2/orgs/{orgId}/apiKeys: get: @@ -51370,6 +55803,17 @@ paths: summary: Return All Organization API Keys tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeys post: description: Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -51407,6 +55851,18 @@ paths: summary: Create One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/apiKeys" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: @@ -51443,6 +55899,17 @@ paths: summary: Remove One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKey get: description: Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51482,6 +55949,17 @@ paths: summary: Return One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKey patch: description: Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -51528,6 +56006,18 @@ paths: summary: Update One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/updateApiKey /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: @@ -51569,6 +56059,17 @@ paths: summary: Return All Access List Entries for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/listApiKeyAccessListsEntries post: description: Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Read Write role. @@ -51619,6 +56120,18 @@ paths: summary: Create Access List Entries for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKeyAccessList /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: @@ -51665,6 +56178,17 @@ paths: summary: Remove One Access List Entry for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/deleteApiKeyAccessListEntry get: description: Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -51710,6 +56234,17 @@ paths: summary: Return One Access List Entry for One Organization API Key tags: - Programmatic API Keys + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: @@ -51746,6 +56281,18 @@ paths: summary: Create Cost Explorer query process tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/createCostExplorerQueryProcess /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: @@ -51792,6 +56339,17 @@ paths: summary: Return results from a given Cost Explorer query, or notify that the results are not ready yet. tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getCostExplorerQueryProcess --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getCostExplorerQueryProcess /api/atlas/v2/orgs/{orgId}/events: get: @@ -51864,6 +56422,17 @@ paths: summary: Return All Events from One Organization tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/events?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/listOrganizationEvents /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: @@ -51913,6 +56482,17 @@ paths: summary: Return One Event from One Organization tags: - Events + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Events/operation/getOrganizationEvent /api/atlas/v2/orgs/{orgId}/federationSettings: get: @@ -51945,6 +56525,17 @@ paths: summary: Return Federation Settings for One Organization tags: - Federated Authentication + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getFederationSettings /api/atlas/v2/orgs/{orgId}/groups: get: @@ -51995,6 +56586,17 @@ paths: summary: Return One or More Projects in One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationProjects /api/atlas/v2/orgs/{orgId}/invites: get: @@ -52046,6 +56648,17 @@ paths: summary: Return All Organization Invitations tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invites?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/listOrganizationInvitations patch: @@ -52090,6 +56703,18 @@ paths: summary: Update One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitation post: @@ -52134,6 +56759,18 @@ paths: summary: Invite One MongoDB Cloud User to Join One Atlas Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/invites" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/createOrganizationInvitation /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: @@ -52176,6 +56813,17 @@ paths: summary: Cancel One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/deleteOrganizationInvitation get: @@ -52221,6 +56869,17 @@ paths: summary: Return One Organization Invitation tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation patch: @@ -52272,6 +56931,18 @@ paths: summary: Update One Organization Invitation by Invitation ID tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationInvitationById /api/atlas/v2/orgs/{orgId}/invoices: @@ -52364,6 +57035,17 @@ paths: summary: Return All Invoices for One Organization tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listInvoices /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: @@ -52409,6 +57091,17 @@ paths: summary: Return One Organization Invoice tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/getInvoice /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: @@ -52453,6 +57146,17 @@ paths: summary: Return One Organization Invoice as CSV tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCsv --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/downloadInvoiceCsv /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: @@ -52498,6 +57202,17 @@ paths: summary: Query lineItems of the specified invoiceId tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api queryLineItemsFromSingleInvoice --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/queryLineItemsFromSingleInvoice /api/atlas/v2/orgs/{orgId}/invoices/pending: get: @@ -52526,6 +57241,17 @@ paths: summary: Return All Pending Invoices for One Organization tags: - Invoices + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Invoices/operation/listPendingInvoices /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: @@ -52560,6 +57286,17 @@ paths: summary: Return All Projects Available for Migration tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/listSourceProjects /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: @@ -52587,6 +57324,17 @@ paths: summary: Remove One Link-Token tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/deleteLinkToken post: description: Create one link-token that contains all the information required to complete the link. MongoDB Atlas uses the link-token for push live migrations only. Live migration (push) allows you to securely push data from Cloud Manager or Ops Manager into MongoDB Atlas. Your API Key must have the Organization Owner role to successfully call this resource. @@ -52623,6 +57371,18 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Migration-Service/operation/createLinkToken /api/atlas/v2/orgs/{orgId}/nonCompliantResources: get: @@ -52663,6 +57423,17 @@ paths: summary: Return all non-compliant resources tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/nonCompliantResources?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getResourcesNonCompliant --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getResourcesNonCompliant /api/atlas/v2/orgs/{orgId}/resourcePolicies: get: @@ -52704,6 +57475,17 @@ paths: summary: Return all Atlas Resource Policies tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/resourcePolicies?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasResourcePolicies --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicies post: description: Create one Atlas Resource Policy for an org. @@ -52749,6 +57531,18 @@ paths: summary: Create one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/resourcePolicies" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/createAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: delete: @@ -52790,6 +57584,17 @@ paths: summary: Delete one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy get: description: Return one Atlas Resource Policy for an org. @@ -52834,6 +57639,17 @@ paths: summary: Return one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/getAtlasResourcePolicy patch: description: Update one Atlas Resource Policy for an org. @@ -52889,6 +57705,18 @@ paths: summary: Update one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/updateAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: post: @@ -52935,6 +57763,18 @@ paths: summary: Validate one Atlas Resource Policy tags: - Resource Policies + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api validateAtlasResourcePolicy --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/validateAtlasResourcePolicy /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: @@ -52965,6 +57805,17 @@ paths: summary: List All Organization Service Accounts tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccounts post: description: Creates one Service Account for the specified Organization. @@ -53001,6 +57852,18 @@ paths: summary: Create one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: @@ -53035,6 +57898,17 @@ paths: summary: Delete one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccount get: description: Returns the specified Service Account. @@ -53072,6 +57946,17 @@ paths: summary: Get one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/getServiceAccount patch: description: Updates the specified Service Account in the specified Organization. @@ -53116,6 +58001,18 @@ paths: summary: Update one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/updateServiceAccount /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList: get: @@ -53155,6 +58052,17 @@ paths: summary: Return All Access List entries for one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountAccessList post: description: Add Access List Entries for the specified Service Account for the organization. Resources require all API requests to originate from IP addresses on the API access list. @@ -53208,6 +58116,18 @@ paths: summary: Add Access List entries for one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountAccessList --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountAccessList /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}: delete: @@ -53252,6 +58172,17 @@ paths: summary: Remove One Access List entry from one Organization Service Account tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/accessList/{ipAddress}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountAccessListEntry --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountAccessListEntry /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: @@ -53293,6 +58224,17 @@ paths: summary: Return All Service Account Project assignments tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/listServiceAccountProjects /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: @@ -53338,6 +58280,18 @@ paths: summary: Create one Organization Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/createServiceAccountSecret /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: @@ -53378,6 +58332,17 @@ paths: summary: Delete a Organization Service Account Secret tags: - Service Accounts + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Service-Accounts/operation/deleteServiceAccountSecret /api/atlas/v2/orgs/{orgId}/settings: get: @@ -53408,6 +58373,17 @@ paths: summary: Return Settings for One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/settings?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationSettings patch: description: Updates the organization's settings. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53444,6 +58420,18 @@ paths: summary: Update Settings for One Organization tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/settings" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationSettings /api/atlas/v2/orgs/{orgId}/teams: get: @@ -53480,6 +58468,17 @@ paths: summary: Return All Teams in One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/listOrganizationTeams post: description: Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53521,6 +58520,18 @@ paths: summary: Create One Team in One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/createTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: @@ -53559,6 +58570,17 @@ paths: summary: Remove One Team from One Organization tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/teams/{teamId}" + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/deleteTeam get: description: Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Member role. @@ -53598,6 +58620,17 @@ paths: summary: Return One Team using its ID tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamById patch: description: Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting Service Account or API Key must have the Organization Owner role. @@ -53646,6 +58679,18 @@ paths: summary: Rename One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/teams/{teamId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/renameTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: @@ -53707,6 +58752,17 @@ paths: summary: Return All MongoDB Cloud Users Assigned to One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listTeamUsers post: deprecated: true @@ -53761,6 +58817,18 @@ paths: summary: Assign MongoDB Cloud Users from One Organization to One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/addTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: @@ -53811,6 +58879,17 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/removeTeamUser /api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser: @@ -53862,6 +58941,18 @@ paths: summary: Add One MongoDB Cloud User to One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:addUser" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addUserToTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addUserToTeam /api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser: post: @@ -53912,6 +59003,18 @@ paths: summary: Remove One MongoDB Cloud User from One Team tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/teams/{teamId}:removeUser" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeUserFromTeam --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeUserFromTeam /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: @@ -53951,6 +59054,17 @@ paths: summary: Return One Team using its Name tags: - Teams + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Teams/operation/getTeamByName /api/atlas/v2/orgs/{orgId}/users: get: @@ -54004,6 +59118,17 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/users?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers post: description: |- @@ -54045,6 +59170,18 @@ paths: summary: Add One MongoDB Cloud User to One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createOrganizationUser /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: @@ -54090,6 +59227,17 @@ paths: summary: Remove One MongoDB Cloud User From One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X DELETE "/api/atlas/v2/orgs/{orgId}/users/{userId}" + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationUser get: description: |- @@ -54131,6 +59279,17 @@ paths: summary: Return One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/orgs/{orgId}/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getOrganizationUser patch: description: |- @@ -54182,6 +59341,18 @@ paths: summary: Update One MongoDB Cloud User in One Organization tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PATCH "/api/atlas/v2/orgs/{orgId}/users/{userId}" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: @@ -54225,6 +59396,18 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X PUT "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/updateOrganizationRoles /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: @@ -54280,6 +59463,18 @@ paths: summary: Add One Organization Role to One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api addOrganizationRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/addOrganizationRole /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: post: @@ -54332,6 +59527,18 @@ paths: summary: Remove One Organization Role from One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationRole --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/removeOrganizationRole /api/atlas/v2/unauth/controlPlaneIPAddresses: get: @@ -54353,7 +59560,65 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIpAddresses --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Root/operation/returnAllControlPlaneIpAddresses + /api/atlas/v2/unauth/openapi/versions: + get: + description: API that provides a list of available versionsfor a given environment. + operationId: getApiVersions + parameters: + - $ref: '#/components/parameters/envelope' + - $ref: '#/components/parameters/itemsPerPage' + - $ref: '#/components/parameters/pageNum' + - $ref: '#/components/parameters/pretty' + - description: The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com). + in: query + name: env + schema: + enum: + - dev + - qa + - prod + - stage + type: string + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: '#/components/schemas/PaginatedApiVersions' + x-xgen-version: "2024-08-05" + application/vnd.atlas.2024-08-05+yaml: + schema: + $ref: '#/components/schemas/PaginatedApiVersions' + x-xgen-version: "2024-08-05" + description: OK + "500": + $ref: '#/components/responses/internalServerError' + summary: Provides a list of versions for a given environment. + tags: + - OpenAPI + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/unauth/openapi/versions?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getApiVersions --help /api/atlas/v2/users: post: deprecated: true @@ -54393,6 +59658,18 @@ paths: summary: Create One MongoDB Cloud User tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X POST "/api/atlas/v2/users" + -d { } + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/createUser /api/atlas/v2/users/{userId}: @@ -54434,6 +59711,17 @@ paths: summary: Return One MongoDB Cloud User using Its ID tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/users/{userId}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUser /api/atlas/v2/users/byName/{userName}: get: @@ -54472,6 +59760,17 @@ paths: summary: Return One MongoDB Cloud User using Their Username tags: - MongoDB Cloud Users + x-codeSamples: + - label: curl + lang: cURL + source: |- + curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-03-12+json" \ + -X GET "/api/atlas/v2/users/byName/{userName}?pretty=true" + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help x-sunset: "2026-07-31" x-xgen-docs-url: https://mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/getUserByUsername security: @@ -54549,6 +59848,8 @@ tags: name: Network Peering - description: Returns, adds, edits, or removes an online archive. name: Online Archive + - description: Returns information about the MongoDB Atlas Specification. + name: OpenAPI - description: Returns, adds, and edits organizational units in MongoDB Cloud. name: Organizations - description: Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds. To view field values in a sample query, you must have the Project Data Access Read Only role or higher. Otherwise, MongoDB Cloud returns redacted data rather than the field values. diff --git a/tools/cli/internal/openapi/filter/code_sample.go b/tools/cli/internal/openapi/filter/code_sample.go new file mode 100644 index 0000000000..27f91cfd86 --- /dev/null +++ b/tools/cli/internal/openapi/filter/code_sample.go @@ -0,0 +1,91 @@ +// Copyright 2025 MongoDB Inc +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package filter + +import ( + "time" + + "github.com/getkin/kin-openapi/openapi3" +) + +const codeSampleExtensionName = "x-codeSamples" + +// https://redocly.com/docs-legacy/api-reference-docs/specification-extensions/x-code-samples#x-codesamples +type codeSample struct { + Lang string `json:"lang,omitempty" yaml:"lang,omitempty"` + Label string `json:"label,omitempty" yaml:"label,omitempty"` + Source string `json:"source,omitempty" yaml:"source,omitempty"` +} + +// CodeSampleFilter modifies includes the fields "x-state" and "x-beta" to the "preview" and "upcoming" APIs Operations. +// The "x-state" and "x-beta" fields are bump.sh custom fields to include budges +// Bump.sh feature: https://docs.bump.sh/help/specification-support/doc-code-samples/#example-usage +type CodeSampleFilter struct { + oas *openapi3.T + metadata *Metadata +} + +func (f *CodeSampleFilter) ValidateMetadata() error { + return validateMetadataWithVersion(f.metadata) +} + +func (f *CodeSampleFilter) Apply() error { + for pathName, p := range f.oas.Paths.Map() { + for opK, op := range p.Operations() { + if err := f.includeCodeSamplesForOperation(pathName, opK, op); err != nil { + return err + } + } + } + + return nil +} + +func (f *CodeSampleFilter) newCurlCodeSamplesForOperation(pathName, opK string, op *openapi3.Operation) codeSample { + source := "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n " + + "--header \"Accept: application/vnd.atlas." + f.metadata.targetVersion.Date().Format(time.DateOnly) + "+json\" \\\n " + + switch opK { + case "GET": + source += "-X " + opK + " \"" + pathName + "?pretty=true\"" + case "DELETE": + source += "-X " + opK + " \"" + pathName + "\"" + case "POST", "PATCH", "PUT": + source += "-X " + opK + " \"" + pathName + "\"\n " + source += "-d " + "{ }" + } + + return codeSample{ + Lang: "cURL", + Label: "curl", + Source: source, + } +} + +func (f *CodeSampleFilter) newAtlasCliCodeSamplesForOperation(op *openapi3.Operation) codeSample { + return codeSample{ + Lang: "cURL", + Label: "Atlas CLI", + Source: "atlas api " + op.OperationID + " --help", + } +} + +func (f *CodeSampleFilter) includeCodeSamplesForOperation(pathName, opK string, op *openapi3.Operation) error { + op.Extensions[codeSampleExtensionName] = []codeSample{ + f.newCurlCodeSamplesForOperation(pathName, opK, op), + f.newAtlasCliCodeSamplesForOperation(op), + } + return nil +} diff --git a/tools/cli/internal/openapi/filter/filter.go b/tools/cli/internal/openapi/filter/filter.go index 1e95bdc09a..5967f55f6d 100644 --- a/tools/cli/internal/openapi/filter/filter.go +++ b/tools/cli/internal/openapi/filter/filter.go @@ -81,6 +81,7 @@ func DefaultFilters(oas *openapi3.T, metadata *Metadata) []Filter { &SunsetFilter{oas: oas}, &SchemasFilter{oas: oas}, &BumpFilter{oas: oas, metadata: metadata}, + &CodeSampleFilter{oas: oas, metadata: metadata}, } } diff --git a/tools/cli/internal/openapi/filter/filter_test.go b/tools/cli/internal/openapi/filter/filter_test.go index d6faa66f1f..7cc14eadf5 100644 --- a/tools/cli/internal/openapi/filter/filter_test.go +++ b/tools/cli/internal/openapi/filter/filter_test.go @@ -112,7 +112,7 @@ func TestDefaultFilters(t *testing.T) { metadata := &Metadata{} filters := DefaultFilters(doc, metadata) - assert.Len(t, filters, 10) + assert.Len(t, filters, 11) } func TestFiltersWithoutVersioning(t *testing.T) {