diff --git a/.github/scripts/split_spec.sh b/.github/scripts/split_spec.sh index 3f348be4b9..e541b20775 100755 --- a/.github/scripts/split_spec.sh +++ b/.github/scripts/split_spec.sh @@ -2,7 +2,7 @@ set -eou pipefail echo "Running FOAS CLI versions command" -foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" --stability-level stable --stability-level preview +foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" --stability-level stable --stability-level preview --stability-level upcoming echo "Running FOAS CLI split command with the following --env=${target_env:?} and -o=./openapi/v2/openapi.json" diff --git a/tools/cli/internal/openapi/filter/code_sample.go b/tools/cli/internal/openapi/filter/code_sample.go index b7f96824b4..1c8bc8d686 100644 --- a/tools/cli/internal/openapi/filter/code_sample.go +++ b/tools/cli/internal/openapi/filter/code_sample.go @@ -54,9 +54,9 @@ func (f *CodeSampleFilter) Apply() error { return nil } -func (f *CodeSampleFilter) newCurlCodeSamplesForOperation(pathName, opMethod string) codeSample { +func (f *CodeSampleFilter) newDigestCurlCodeSamplesForOperation(pathName, opMethod string) codeSample { version := apiVersion(f.metadata.targetVersion) - source := "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n " + + source := "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n " + "--header \"Accept: application/vnd.atlas." + version + "+json\" \\\n " switch opMethod { @@ -65,14 +65,37 @@ func (f *CodeSampleFilter) newCurlCodeSamplesForOperation(pathName, opMethod str case "DELETE": source += "-X " + opMethod + " \"https://cloud.mongodb.com" + pathName + "\"" case "POST", "PATCH", "PUT": - source += "--header \"Content-Type: application/vnd.atlas." + version + "+json\" \\\n " + source += "--header \"Content-Type: application/json\" \\\n " source += "-X " + opMethod + " \"https://cloud.mongodb.com" + pathName + "\" \\\n " source += "-d " + "'{ }'" } return codeSample{ Lang: "cURL", - Label: "curl", + Label: "curl (Digest)", + Source: source, + } +} + +func (f *CodeSampleFilter) newServiceAccountCurlCodeSamplesForOperation(pathName, opMethod string) codeSample { + version := apiVersion(f.metadata.targetVersion) + source := "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n " + + "--header \"Accept: application/vnd.atlas." + version + "+json\" \\\n " + + switch opMethod { + case "GET": + source += "-X " + opMethod + " \"https://cloud.mongodb.com" + pathName + "?pretty=true\"" + case "DELETE": + source += "-X " + opMethod + " \"https://cloud.mongodb.com" + pathName + "\"" + case "POST", "PATCH", "PUT": + source += "--header \"Content-Type: application/json\" \\\n " + source += "-X " + opMethod + " \"https://cloud.mongodb.com" + pathName + "\" \\\n " + source += "-d " + "'{ }'" + } + + return codeSample{ + Lang: "cURL", + Label: "curl (Service Accounts)", Source: source, } } @@ -108,8 +131,9 @@ func (f *CodeSampleFilter) includeCodeSamplesForOperation(pathName, opMethod str } op.Extensions[codeSampleExtensionName] = []codeSample{ - f.newCurlCodeSamplesForOperation(pathName, opMethod), newAtlasCliCodeSamplesForOperation(op), + f.newServiceAccountCurlCodeSamplesForOperation(pathName, opMethod), + f.newDigestCurlCodeSamplesForOperation(pathName, opMethod), } return nil } diff --git a/tools/cli/internal/openapi/filter/code_sample_test.go b/tools/cli/internal/openapi/filter/code_sample_test.go index 5cdc8e9c77..39ac1ac50c 100644 --- a/tools/cli/internal/openapi/filter/code_sample_test.go +++ b/tools/cli/internal/openapi/filter/code_sample_test.go @@ -76,16 +76,22 @@ func TestCodeSampleFilter(t *testing.T) { Extensions: map[string]any{ "x-sunset": "9999-12-31", "x-codeSamples": []codeSample{ + { + Lang: "cURL", + Label: "Atlas CLI", + Source: "atlas api testOperationID --help", + }, { Lang: "cURL", - Label: "curl", - Source: "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n " + + Label: "curl (Service Accounts)", + Source: "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n " + "--header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, { - Lang: "cURL", - Label: "Atlas CLI", - Source: "atlas api testOperationID --help", + Lang: "cURL", + Label: "curl (Digest)", + Source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n " + + "--header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, }, }, @@ -139,16 +145,22 @@ func TestCodeSampleFilter(t *testing.T) { Extensions: map[string]any{ "x-sunset": "9999-12-31", "x-codeSamples": []codeSample{ + { + Lang: "cURL", + Label: "Atlas CLI", + Source: "atlas api testOperationID --help", + }, { Lang: "cURL", - Label: "curl", - Source: "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n " + + Label: "curl (Service Accounts)", + Source: "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n " + "--header \"Accept: application/vnd.atlas.preview+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, { - Lang: "cURL", - Label: "Atlas CLI", - Source: "atlas api testOperationID --help", + Lang: "cURL", + Label: "curl (Digest)", + Source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n " + + "--header \"Accept: application/vnd.atlas.preview+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, }, }, @@ -202,16 +214,22 @@ func TestCodeSampleFilter(t *testing.T) { Extensions: map[string]any{ "x-sunset": "9999-12-31", "x-codeSamples": []codeSample{ + { + Lang: "cURL", + Label: "Atlas CLI", + Source: "atlas api testOperationID --help", + }, { Lang: "cURL", - Label: "curl", - Source: "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n " + + Label: "curl (Service Accounts)", + Source: "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n " + "--header \"Accept: application/vnd.atlas.2025-01-01.upcoming+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, { - Lang: "cURL", - Label: "Atlas CLI", - Source: "atlas api testOperationID --help", + Lang: "cURL", + Label: "curl (Digest)", + Source: "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n " + + "--header \"Accept: application/vnd.atlas.2025-01-01.upcoming+json\" \\\n " + "-X GET \"https://cloud.mongodb.com/test?pretty=true\"", }, }, }, diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json index 3fed8b16dc..d7754bd531 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json @@ -242,13 +242,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -299,13 +304,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -362,13 +372,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -425,13 +440,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -479,13 +499,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -545,13 +570,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -618,13 +648,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -689,13 +724,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -771,13 +811,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -834,13 +879,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -906,13 +956,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -979,13 +1034,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1053,13 +1113,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1138,13 +1203,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1236,13 +1306,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] } @@ -1310,13 +1385,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ], "x-sunset": "2025-01-01" @@ -1391,13 +1471,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-01-01" @@ -1452,13 +1537,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1518,13 +1608,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1604,13 +1699,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1678,13 +1778,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1738,13 +1843,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -1796,13 +1906,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -1871,13 +1986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -1941,13 +2061,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2029,13 +2154,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2104,13 +2234,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2180,13 +2315,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2257,13 +2397,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2323,13 +2468,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2392,13 +2542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2462,13 +2617,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2533,13 +2693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2615,13 +2780,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2700,13 +2870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -2782,13 +2957,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -2864,13 +3044,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -2936,13 +3121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3021,13 +3211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -3103,13 +3298,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3173,13 +3373,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3239,13 +3444,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3315,13 +3525,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3405,13 +3620,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3486,13 +3706,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3543,13 +3768,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3612,13 +3842,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3669,13 +3904,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -3735,13 +3975,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -3802,13 +4047,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -3878,13 +4128,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -3952,13 +4207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4021,13 +4281,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -4083,13 +4348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ], "x-sunset": "2024-10-01" @@ -4168,13 +4438,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-01" @@ -4226,13 +4501,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4296,13 +4576,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4377,13 +4662,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4446,13 +4736,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4534,13 +4829,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4610,13 +4910,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -4690,13 +4995,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -4776,13 +5086,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -4856,13 +5171,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -4936,13 +5256,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5020,13 +5345,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ], "x-sunset": "2025-06-01" @@ -5095,13 +5425,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -5184,13 +5519,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -5263,13 +5603,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5347,13 +5692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5422,13 +5772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5500,13 +5855,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5587,13 +5947,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -5671,13 +6036,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -5750,13 +6120,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -5820,13 +6195,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ], "x-sunset": "2025-08-05" @@ -5889,13 +6269,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ], "x-sunset": "2025-08-05" @@ -5972,13 +6357,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ], "x-sunset": "2025-08-05" @@ -6054,13 +6444,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6135,13 +6530,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6216,13 +6616,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6298,13 +6703,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6370,13 +6780,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6454,13 +6869,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6536,13 +6956,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6629,13 +7054,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -6721,13 +7151,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -6810,13 +7245,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -6882,13 +7322,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -6966,13 +7411,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7038,13 +7488,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7122,13 +7577,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7201,13 +7661,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7289,13 +7754,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7380,13 +7850,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7476,13 +7951,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7566,13 +8046,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -7651,13 +8136,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7753,13 +8243,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7828,13 +8323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7903,13 +8403,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ], "x-sunset": "2025-06-01" @@ -7990,13 +8495,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8084,13 +8594,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ], "x-sunset": "2025-06-01" @@ -8174,13 +8689,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8350,13 +8870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -8432,13 +8957,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -8523,13 +9053,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -8632,13 +9167,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -8720,13 +9260,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -8809,13 +9354,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -8912,13 +9462,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -8991,13 +9546,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9068,13 +9628,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9153,13 +9718,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9230,13 +9800,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9321,13 +9896,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -9389,13 +9969,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -9483,13 +10068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -9565,13 +10155,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -9650,13 +10245,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -9723,13 +10323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ], "x-sunset": "2026-03-01" @@ -9795,13 +10400,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9881,13 +10491,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -9967,13 +10582,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10038,13 +10658,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -10117,13 +10742,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -10210,13 +10840,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -10295,13 +10930,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -10375,13 +11015,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -10466,13 +11111,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -10535,13 +11185,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -10653,13 +11308,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -10738,13 +11398,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -10816,13 +11481,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -10882,13 +11552,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -10961,13 +11636,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -11029,13 +11709,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -11120,13 +11805,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -11180,13 +11870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -11258,13 +11953,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -11330,13 +12030,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -11397,13 +12102,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -11484,13 +12194,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -11557,13 +12272,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -11632,13 +12352,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -11698,13 +12423,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -11765,13 +12495,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -11852,13 +12587,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -11924,13 +12664,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -12002,13 +12747,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -12081,13 +12831,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -12174,13 +12929,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -12270,13 +13030,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -12336,13 +13101,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -12566,13 +13336,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -12648,13 +13423,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -12725,13 +13505,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -12822,13 +13607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -12900,13 +13690,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -12992,13 +13787,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -13115,13 +13915,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -13235,13 +14040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -13292,13 +14102,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -13367,13 +14182,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -13436,13 +14256,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -13514,13 +14339,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -13606,13 +14436,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -13685,13 +14520,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -13818,13 +14658,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -13899,13 +14744,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -13959,13 +14809,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -14065,13 +14920,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/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" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -14174,13 +15034,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -14275,13 +15140,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -14347,13 +15217,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -14432,13 +15307,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -14515,13 +15395,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -14621,13 +15506,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -14724,13 +15614,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -14794,13 +15689,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -14868,13 +15768,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -14936,13 +15841,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15004,13 +15914,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -15076,13 +15991,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -15159,13 +16079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15220,13 +16145,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -15289,13 +16219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -15376,13 +16311,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -15464,13 +16404,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -15563,13 +16508,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -15643,13 +16593,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15724,13 +16679,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15801,13 +16761,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -15867,13 +16832,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -15933,13 +16903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -15987,13 +16962,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -16042,13 +17022,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -16108,13 +17093,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -16162,13 +17152,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -16216,13 +17211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -16273,13 +17273,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -16330,13 +17335,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -16387,13 +17397,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -16505,13 +17520,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -16588,13 +17608,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -16667,13 +17692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -16739,13 +17769,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -16809,13 +17844,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -16896,13 +17936,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -16956,13 +18001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -17025,13 +18075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -17094,13 +18149,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -17164,13 +18224,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -17248,13 +18313,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -17323,13 +18393,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -17414,13 +18489,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -17486,13 +18566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -17558,13 +18643,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -17649,13 +18739,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -17734,13 +18829,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -17817,13 +18917,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -17900,13 +19005,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -17972,13 +19082,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -18032,13 +19147,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -18101,13 +19221,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -18172,13 +19297,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -18253,13 +19383,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -18333,13 +19468,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -18411,13 +19551,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -18500,13 +19645,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -18575,13 +19725,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -18659,13 +19814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -18744,13 +19904,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -18848,13 +20013,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -18942,13 +20112,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -19037,13 +20212,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -19099,13 +20279,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -19173,13 +20358,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -19245,13 +20435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -19314,13 +20509,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -19386,13 +20586,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -19459,13 +20664,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -19525,13 +20735,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -19593,13 +20808,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -19670,13 +20890,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -19747,13 +20972,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -19863,13 +21093,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -19940,13 +21175,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -20014,13 +21254,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -20139,13 +21384,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -20371,13 +21621,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -20457,13 +21712,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -20567,13 +21827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -20693,13 +21958,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -20756,13 +22026,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -20817,13 +22092,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -20890,13 +22170,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -20963,13 +22248,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -21035,13 +22325,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -21101,13 +22396,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -21167,13 +22467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -21239,13 +22544,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -21320,13 +22630,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -21407,13 +22722,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -21491,13 +22811,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -21572,13 +22897,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -21654,13 +22984,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -21723,13 +23058,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -21796,13 +23136,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -21871,13 +23216,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -21944,13 +23294,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -22025,13 +23380,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -22088,13 +23448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -22160,13 +23525,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -22235,13 +23605,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -22317,13 +23692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -22393,13 +23773,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -22484,13 +23869,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -22541,13 +23931,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -22610,13 +24005,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -22664,13 +24064,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -22721,13 +24126,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -22792,13 +24202,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -22861,13 +24276,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -22945,13 +24365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -23017,13 +24442,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -23103,13 +24533,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -23183,13 +24618,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -23258,13 +24698,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -23324,13 +24769,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -23388,13 +24838,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -23463,13 +24918,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -23533,13 +24993,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -23603,13 +25068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -23676,13 +25146,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -23747,13 +25222,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -23832,13 +25312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -23914,13 +25399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -24010,13 +25500,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -24100,13 +25595,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -24185,13 +25685,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -24253,13 +25758,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -24334,13 +25844,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -24439,13 +25954,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -24520,13 +26040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -24583,13 +26108,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -24663,13 +26193,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -24738,13 +26273,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -24810,13 +26350,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -24882,13 +26427,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -24954,13 +26504,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -25024,13 +26579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -25108,13 +26668,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -25256,13 +26821,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -25316,13 +26886,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -25394,13 +26969,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -25465,13 +27045,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -25528,13 +27113,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -25585,13 +27175,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -25654,13 +27249,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -25717,13 +27317,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -25789,13 +27394,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -25865,13 +27475,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -25944,13 +27559,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -26020,13 +27640,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -26099,13 +27724,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -26176,13 +27806,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -26267,13 +27902,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -26355,13 +27995,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -26449,13 +28094,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -26537,13 +28187,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -26609,13 +28264,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -26684,13 +28344,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -26770,13 +28435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -26838,13 +28508,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -26905,13 +28580,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -26974,13 +28654,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml index 395eafa99f..696ab385ba 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml @@ -28293,16 +28293,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -28330,16 +28336,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -28368,16 +28380,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -28406,16 +28424,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -28442,16 +28466,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -28483,16 +28513,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -28532,16 +28568,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -28580,16 +28622,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -28635,18 +28683,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -28677,16 +28733,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -28723,18 +28785,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -28773,16 +28843,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -28822,16 +28898,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -28878,18 +28960,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -28943,16 +29033,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: get: deprecated: true @@ -28992,16 +29088,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" x-sunset: "2025-01-01" patch: deprecated: true @@ -29049,18 +29151,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' x-sunset: "2025-01-01" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: @@ -29091,16 +29201,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -29131,16 +29247,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -29188,18 +29310,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -29228,16 +29358,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -29265,16 +29401,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -29313,18 +29455,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -29357,16 +29507,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -29411,22 +29567,30 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help - /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: - delete: - description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. - externalDocs: + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' + /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: + delete: + description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. + externalDocs: description: IP access list url: https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list operationId: deleteProjectIpAccessList @@ -29467,16 +29631,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -29517,16 +29687,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -29567,16 +29743,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -29609,16 +29791,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -29656,18 +29844,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -29707,16 +29903,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -29757,16 +29959,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -29816,18 +30024,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -29879,18 +30095,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -29935,16 +30159,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -29988,16 +30218,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -30038,16 +30274,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: deprecated: true description: |- @@ -30097,18 +30339,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -30153,16 +30403,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -30195,16 +30451,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -30237,18 +30499,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -30289,16 +30559,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -30345,18 +30621,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -30400,18 +30684,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -30438,16 +30730,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -30482,18 +30780,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -30520,16 +30826,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -30562,18 +30874,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true @@ -30604,18 +30924,24 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help - x-sunset: "2025-05-30" - post: + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" + x-sunset: "2025-05-30" + post: deprecated: true description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. operationId: createExportBucket @@ -30654,18 +30980,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -30706,16 +31040,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: deprecated: true description: Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -30753,16 +31093,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: @@ -30793,16 +31139,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" x-sunset: "2024-10-01" put: deprecated: true @@ -30849,18 +31201,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' x-sunset: "2024-10-01" /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: @@ -30888,16 +31248,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -30933,18 +31299,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -30988,16 +31362,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31033,16 +31413,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -31091,18 +31477,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: deprecated: true @@ -31139,16 +31533,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" x-sunset: "2025-06-01" post: deprecated: true @@ -31191,18 +31591,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -31249,16 +31657,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" x-sunset: "2025-06-01" get: deprecated: true @@ -31299,16 +31713,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -31358,18 +31778,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: @@ -31409,16 +31837,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -31465,18 +31899,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -31517,16 +31959,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31565,16 +32013,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -31625,18 +32079,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31683,16 +32145,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -31736,16 +32204,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: deprecated: true @@ -31783,16 +32257,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" x-sunset: "2025-08-05" get: deprecated: true @@ -31829,16 +32309,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" x-sunset: "2025-08-05" patch: deprecated: true @@ -31887,18 +32373,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI lang: cURL - source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' x-sunset: "2025-08-05" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -31940,16 +32434,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -31996,18 +32496,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -32054,16 +32562,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -32109,16 +32623,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -32171,18 +32691,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32227,16 +32755,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -32282,16 +32816,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32329,16 +32869,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -32389,18 +32935,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -32449,18 +33003,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32498,16 +33060,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32554,16 +33122,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32601,16 +33175,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32657,16 +33237,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -32706,16 +33292,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -32765,16 +33357,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -32825,18 +33423,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -32891,16 +33497,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -32952,16 +33564,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -33010,16 +33628,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -33079,18 +33703,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -33131,16 +33763,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -33181,16 +33819,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" x-sunset: "2025-06-01" post: deprecated: true @@ -33239,21 +33883,29 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help - x-sunset: "2025-06-01" - /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: - delete: + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' + x-sunset: "2025-06-01" + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: + delete: deprecated: true description: Removes 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. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -33303,16 +33955,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" x-sunset: "2025-06-01" post: deprecated: true @@ -33363,18 +34021,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -33486,18 +34152,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33539,16 +34213,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -33599,18 +34279,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -33660,16 +34348,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -33720,16 +34414,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -33789,18 +34489,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -33866,16 +34574,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -33918,16 +34632,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -33969,16 +34689,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -34025,18 +34751,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: deprecated: true @@ -34078,16 +34812,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -34139,18 +34879,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -34186,18 +34934,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: @@ -34251,16 +35007,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -34305,18 +35067,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -34367,16 +35137,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: deprecated: true @@ -34415,16 +35191,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" x-sunset: "2026-03-01" get: deprecated: true @@ -34463,16 +35245,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -34520,18 +35308,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" post: deprecated: true @@ -34579,18 +35375,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -34631,16 +35435,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -34686,20 +35496,28 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help - /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: - get: + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: + get: deprecated: true description: Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). operationId: listLegacySnapshots @@ -34747,16 +35565,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -34804,16 +35628,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -34858,16 +35688,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -34919,18 +35755,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34966,16 +35810,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: deprecated: true @@ -35047,16 +35897,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: @@ -35099,16 +35955,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -35150,18 +36012,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -35203,18 +36073,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -35257,16 +36135,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -35307,18 +36191,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -35361,16 +36253,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -35406,16 +36304,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -35466,18 +36370,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35507,16 +36419,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35545,16 +36463,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -35595,18 +36519,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -35643,16 +36575,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -35686,16 +36624,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -35742,18 +36686,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -35791,16 +36743,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -35839,18 +36797,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -35883,16 +36849,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -35927,16 +36899,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -35983,18 +36961,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36031,16 +37017,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -36091,16 +37083,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -36151,16 +37149,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -36221,18 +37225,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -36289,16 +37301,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36328,16 +37346,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -36469,18 +37493,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -36537,16 +37569,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -36600,16 +37638,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -36676,18 +37720,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36725,16 +37777,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -36790,18 +37848,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -36874,16 +37940,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -36953,16 +38025,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -36992,16 +38070,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -37052,18 +38136,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -37098,16 +38190,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -37148,18 +38246,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -37210,16 +38316,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -37262,16 +38374,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -37355,16 +38473,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -37411,16 +38535,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -37449,16 +38579,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -37517,16 +38653,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -37584,16 +38726,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -37650,16 +38798,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -37693,16 +38847,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -37751,16 +38911,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -37808,16 +38974,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -37877,18 +39049,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -37946,18 +39126,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -37993,16 +39181,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -38041,18 +39235,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -38087,18 +39289,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -38135,16 +39345,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -38183,16 +39399,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -38239,18 +39461,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -38280,16 +39510,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38324,16 +39560,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -38400,16 +39642,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -38477,16 +39725,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -38564,18 +39818,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: deprecated: true @@ -38625,18 +39887,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -38669,16 +39939,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -38710,18 +39986,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: deprecated: true @@ -38764,18 +40048,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -38818,16 +40110,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -38853,16 +40151,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -38888,16 +40192,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -38931,18 +40241,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -38968,18 +40286,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -39005,18 +40331,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deferMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -39043,16 +40377,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39079,16 +40419,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39115,18 +40461,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -39194,16 +40548,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39245,16 +40605,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -39296,18 +40662,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -39345,16 +40719,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -39391,16 +40771,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -39448,18 +40834,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39489,16 +40883,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -39534,18 +40934,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -39582,16 +40990,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -39628,16 +41042,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -39684,18 +41104,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39735,16 +41163,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39792,16 +41226,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39839,18 +41279,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39888,18 +41336,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39947,16 +41403,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -40004,16 +41466,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -40060,16 +41528,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -40114,18 +41588,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40165,16 +41647,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40221,16 +41709,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -40278,16 +41772,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -40347,18 +41847,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -40412,16 +41920,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -40476,16 +41990,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -40522,18 +42042,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40562,16 +42090,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -40606,18 +42140,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -40655,16 +42197,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -40712,18 +42260,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -40768,16 +42324,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -40821,16 +42383,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -40881,18 +42449,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -40923,16 +42499,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40971,18 +42553,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -41016,16 +42606,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -41079,18 +42675,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41128,16 +42732,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -41176,16 +42786,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41215,16 +42831,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41259,16 +42881,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41306,16 +42934,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41356,16 +42990,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41432,16 +43072,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41479,16 +43125,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41528,16 +43180,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -41620,16 +43278,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -41823,16 +43487,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41887,16 +43557,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -41968,16 +43644,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42056,16 +43738,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -42096,16 +43784,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -42135,16 +43829,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -42182,18 +43882,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -42231,18 +43939,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -42281,18 +43997,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -42327,16 +44051,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42366,16 +44096,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -42412,18 +44148,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42464,16 +44208,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -42521,18 +44271,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createServerlessBackupRestoreJob --help /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42579,16 +44337,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42629,16 +44393,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42685,16 +44455,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -42730,16 +44506,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -42779,18 +44561,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -42830,16 +44620,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -42878,16 +44674,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -42931,18 +44733,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42973,16 +44783,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -43019,18 +44835,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43066,16 +44890,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -43119,18 +44949,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -43172,16 +45010,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -43232,18 +45076,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43270,16 +45122,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43317,18 +45175,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -43357,16 +45223,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43393,16 +45265,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43438,18 +45316,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43485,16 +45371,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43536,16 +45428,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43583,16 +45481,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -43639,18 +45543,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -43690,16 +45602,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -43739,16 +45657,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listOrganizations --help post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -43788,18 +45712,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -43838,16 +45770,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -43879,16 +45817,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -43927,18 +45871,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -43971,16 +45923,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -44016,18 +45974,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -44066,16 +46032,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -44113,16 +46085,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -44169,18 +46147,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -44222,16 +46208,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -44282,18 +46274,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -44344,16 +46344,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -44401,16 +46407,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -44445,18 +46457,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -44501,16 +46521,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -44572,16 +46598,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -44628,16 +46660,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -44668,16 +46706,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -44724,16 +46768,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -44772,16 +46822,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -44818,18 +46874,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -44866,18 +46930,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -44914,16 +46986,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -44961,16 +47039,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -45016,18 +47100,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -45118,16 +47210,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -45171,16 +47269,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -45225,16 +47329,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -45263,16 +47373,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -45303,16 +47419,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -45340,16 +47462,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -45384,18 +47512,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45426,16 +47562,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -45472,18 +47614,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -45520,16 +47670,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -45571,18 +47727,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45625,16 +47789,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -45676,16 +47846,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -45736,18 +47912,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -45794,16 +47978,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -45856,18 +48046,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45917,16 +48115,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -45966,16 +48170,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -46009,16 +48219,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -46059,16 +48275,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -46115,18 +48337,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/users: post: description: |- @@ -46166,18 +48396,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -46214,16 +48452,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -46258,16 +48502,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json index 0008fe5877..71da698ebc 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json @@ -246,13 +246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -303,13 +308,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -366,13 +376,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -429,13 +444,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -483,13 +503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -549,13 +574,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -622,13 +652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -693,13 +728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -775,13 +815,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -838,13 +883,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -910,13 +960,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -983,13 +1038,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1057,13 +1117,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1142,13 +1207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1240,13 +1310,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] } @@ -1314,13 +1389,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ], "x-sunset": "2025-01-01" @@ -1395,13 +1475,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-01-01" @@ -1456,13 +1541,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1522,13 +1612,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1608,13 +1703,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1682,13 +1782,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1742,13 +1847,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -1800,13 +1910,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -1875,13 +1990,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -1951,13 +2071,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2021,13 +2146,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2109,13 +2239,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2184,13 +2319,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2260,13 +2400,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2337,13 +2482,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2403,13 +2553,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2472,13 +2627,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2542,13 +2702,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2613,13 +2778,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2695,13 +2865,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2780,13 +2955,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -2862,13 +3042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -2944,13 +3129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3016,13 +3206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3101,13 +3296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -3183,13 +3383,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3253,13 +3458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3319,13 +3529,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3395,13 +3610,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3485,13 +3705,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3566,13 +3791,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3623,13 +3853,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3692,13 +3927,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3749,13 +3989,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -3815,13 +4060,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -3882,13 +4132,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -3958,13 +4213,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -4032,13 +4292,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4101,13 +4366,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -4163,13 +4433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ], "x-sunset": "2024-10-01" @@ -4248,13 +4523,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-01" @@ -4306,13 +4586,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4376,13 +4661,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4457,13 +4747,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4526,13 +4821,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4614,13 +4914,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4690,13 +4995,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -4770,13 +5080,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -4856,13 +5171,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -4936,13 +5256,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5016,13 +5341,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5099,13 +5429,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5173,13 +5508,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -5262,13 +5602,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5341,13 +5686,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5425,13 +5775,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5500,13 +5855,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5578,13 +5938,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5665,13 +6030,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -5749,13 +6119,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -5828,13 +6203,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -5898,13 +6278,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ], "x-sunset": "2025-08-05" @@ -5967,13 +6352,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ], "x-sunset": "2025-08-05" @@ -6050,13 +6440,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ], "x-sunset": "2025-08-05" @@ -6132,13 +6527,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6213,13 +6613,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6294,13 +6699,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6376,13 +6786,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6448,13 +6863,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6532,13 +6952,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6614,13 +7039,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6707,13 +7137,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -6799,13 +7234,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -6888,13 +7328,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -6960,13 +7405,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7044,13 +7494,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7116,13 +7571,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7200,13 +7660,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7279,13 +7744,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7367,13 +7837,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7458,13 +7933,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7554,13 +8034,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7644,13 +8129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -7729,13 +8219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7831,13 +8326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7906,13 +8406,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -7981,13 +8486,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ], "x-sunset": "2026-03-01" @@ -8068,13 +8578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8162,13 +8677,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ], "x-sunset": "2026-03-01" @@ -8252,13 +8772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8428,13 +8953,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -8510,13 +9040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -8601,13 +9136,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -8710,13 +9250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -8798,13 +9343,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -8887,13 +9437,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -8990,13 +9545,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9069,13 +9629,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9146,13 +9711,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9231,13 +9801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9308,13 +9883,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9399,13 +9979,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -9466,13 +10051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -9559,13 +10149,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -9641,13 +10236,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -9726,13 +10326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -9799,13 +10404,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ], "x-sunset": "2026-03-01" @@ -9871,13 +10481,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9957,13 +10572,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10043,13 +10663,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10114,13 +10739,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -10193,13 +10823,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -10286,13 +10921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -10371,13 +11011,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -10451,13 +11096,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -10542,13 +11192,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -10611,13 +11266,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -10728,13 +11388,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -10812,13 +11477,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -10890,13 +11560,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -10956,13 +11631,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -11035,13 +11715,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -11103,13 +11788,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -11194,13 +11884,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -11254,13 +11949,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -11332,13 +12032,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -11404,13 +12109,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -11471,13 +12181,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -11558,13 +12273,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -11631,13 +12351,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -11706,13 +12431,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -11772,13 +12502,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -11839,13 +12574,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -11926,13 +12666,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -11998,13 +12743,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -12076,13 +12826,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -12155,13 +12910,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -12248,13 +13008,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -12344,13 +13109,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -12410,13 +13180,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -12640,13 +13415,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -12722,13 +13502,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -12799,13 +13584,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -12896,13 +13686,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -12974,13 +13769,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -13066,13 +13866,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -13189,13 +13994,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -13309,13 +14119,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -13366,13 +14181,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -13441,13 +14261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -13510,13 +14335,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -13588,13 +14418,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -13680,13 +14515,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -13759,13 +14599,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -13892,13 +14737,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -13973,13 +14823,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -14033,13 +14888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -14139,13 +14999,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -14248,13 +15113,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -14349,13 +15219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -14421,13 +15296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -14506,13 +15386,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -14589,13 +15474,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -14695,13 +15585,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -14798,13 +15693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -14868,13 +15768,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -14942,13 +15847,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15010,13 +15920,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15078,13 +15993,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -15150,13 +16070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -15233,13 +16158,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15294,13 +16224,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -15363,13 +16298,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -15450,13 +16390,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -15538,13 +16483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -15637,13 +16587,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -15717,13 +16672,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15798,13 +16758,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15875,13 +16840,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -15941,13 +16911,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -16007,13 +16982,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -16061,13 +17041,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -16116,13 +17101,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -16182,13 +17172,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -16236,13 +17231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -16290,13 +17290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -16347,13 +17352,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -16404,13 +17414,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -16461,13 +17476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -16579,13 +17599,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -16662,13 +17687,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -16741,13 +17771,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -16813,13 +17848,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -16883,13 +17923,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -16970,13 +18015,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -17030,13 +18080,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -17099,13 +18154,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -17168,13 +18228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -17238,13 +18303,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -17322,13 +18392,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -17397,13 +18472,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -17488,13 +18568,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -17560,13 +18645,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -17632,13 +18722,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -17723,13 +18818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -17808,13 +18908,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -17891,13 +18996,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -17974,13 +19084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -18046,13 +19161,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -18106,13 +19226,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -18175,13 +19300,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -18246,13 +19376,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -18327,13 +19462,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -18407,13 +19547,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -18485,13 +19630,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -18574,13 +19724,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -18649,13 +19804,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -18733,13 +19893,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -18818,13 +19983,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -18922,13 +20092,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -19016,13 +20191,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -19111,13 +20291,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -19173,13 +20358,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -19247,13 +20437,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -19319,13 +20514,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -19388,13 +20588,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -19460,13 +20665,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -19533,13 +20743,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -19599,13 +20814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -19667,13 +20887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -19744,13 +20969,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -19821,13 +21051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -19937,13 +21172,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -20014,13 +21254,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -20088,13 +21333,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -20213,13 +21463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -20445,13 +21700,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -20531,13 +21791,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -20641,13 +21906,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -20767,13 +22037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -20830,13 +22105,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -20891,13 +22171,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -20964,13 +22249,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -21037,13 +22327,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -21109,13 +22404,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -21175,13 +22475,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -21241,13 +22546,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -21313,13 +22623,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -21394,13 +22709,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -21481,13 +22801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -21565,13 +22890,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -21646,13 +22976,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -21728,13 +23063,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -21797,13 +23137,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -21870,13 +23215,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -21945,13 +23295,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -22018,13 +23373,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -22099,13 +23459,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -22162,13 +23527,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -22234,13 +23604,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -22297,13 +23672,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -22366,13 +23746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -22438,13 +23823,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -22513,13 +23903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -22597,13 +23992,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -22696,13 +24096,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -22771,13 +24176,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -22852,13 +24262,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -22933,13 +24348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -23006,13 +24426,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -23099,13 +24524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -23174,13 +24604,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -23256,13 +24691,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -23332,13 +24772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -23423,13 +24868,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -23480,13 +24930,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -23549,13 +25004,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -23603,13 +25063,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -23660,13 +25125,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -23731,13 +25201,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -23800,13 +25275,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -23884,13 +25364,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -23956,13 +25441,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -24042,13 +25532,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -24122,13 +25617,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -24197,13 +25697,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -24263,13 +25768,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -24327,13 +25837,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -24402,13 +25917,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -24472,13 +25992,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -24542,13 +26067,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -24615,13 +26145,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -24686,13 +26221,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -24771,13 +26311,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -24853,13 +26398,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -24949,13 +26499,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -25039,13 +26594,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -25124,13 +26684,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -25192,13 +26757,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -25273,13 +26843,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -25378,13 +26953,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -25459,13 +27039,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -25522,13 +27107,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -25602,13 +27192,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -25677,13 +27272,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -25749,13 +27349,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -25821,13 +27426,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -25893,13 +27503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -25963,13 +27578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -26047,13 +27667,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -26195,13 +27820,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -26255,13 +27885,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -26333,13 +27968,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -26404,13 +28044,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -26467,13 +28112,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -26524,13 +28174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -26593,13 +28248,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -26656,13 +28316,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -26728,13 +28393,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -26804,13 +28474,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -26883,13 +28558,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -26959,13 +28639,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -27038,13 +28723,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -27115,13 +28805,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -27206,13 +28901,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -27294,13 +28994,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -27388,13 +29093,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -27476,13 +29186,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -27548,13 +29263,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -27623,13 +29343,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -27709,13 +29434,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -27777,13 +29507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-02-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -27844,13 +29579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -27913,13 +29653,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml index 3c2c29d556..75e558fde1 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml @@ -28657,16 +28657,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -28694,16 +28700,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -28732,16 +28744,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -28770,16 +28788,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -28806,16 +28830,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -28847,16 +28877,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -28896,16 +28932,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -28944,16 +28986,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -28999,18 +29047,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -29041,16 +29097,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -29087,18 +29149,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -29137,16 +29207,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -29186,16 +29262,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -29242,18 +29324,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -29307,16 +29397,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: get: deprecated: true @@ -29356,16 +29452,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" x-sunset: "2025-01-01" patch: deprecated: true @@ -29413,18 +29515,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' x-sunset: "2025-01-01" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: @@ -29455,16 +29565,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -29495,16 +29611,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -29552,18 +29674,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -29592,16 +29722,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -29629,16 +29765,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -29677,18 +29819,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -29727,18 +29877,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -29771,16 +29929,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -29825,18 +29989,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -29881,16 +30053,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -29931,16 +30109,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -29981,16 +30165,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -30023,16 +30213,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30070,18 +30266,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -30121,16 +30325,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -30171,16 +30381,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30230,18 +30446,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30293,18 +30517,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -30349,16 +30581,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -30402,16 +30640,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -30452,16 +30696,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: deprecated: true description: |- @@ -30511,18 +30761,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -30567,16 +30825,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -30609,16 +30873,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -30651,18 +30921,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -30703,16 +30981,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -30759,18 +31043,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -30814,18 +31106,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -30852,16 +31152,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -30896,18 +31202,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -30934,16 +31248,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -30976,18 +31296,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true @@ -31018,16 +31346,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" x-sunset: "2025-05-30" post: deprecated: true @@ -31068,18 +31402,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -31120,16 +31462,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: deprecated: true description: Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31167,16 +31515,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: @@ -31207,16 +31561,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" x-sunset: "2024-10-01" put: deprecated: true @@ -31263,18 +31623,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' x-sunset: "2024-10-01" /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: @@ -31302,16 +31670,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -31347,18 +31721,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -31402,16 +31784,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31447,16 +31835,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -31505,18 +31899,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: deprecated: true @@ -31553,16 +31955,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" x-sunset: "2026-03-01" post: deprecated: true @@ -31605,18 +32013,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -31662,16 +32078,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: deprecated: true description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -31711,16 +32133,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -31770,18 +32198,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: @@ -31821,16 +32257,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -31877,18 +32319,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -31929,16 +32379,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31977,16 +32433,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -32037,18 +32499,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32095,16 +32565,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -32148,16 +32624,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: deprecated: true @@ -32195,16 +32677,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" x-sunset: "2025-08-05" get: deprecated: true @@ -32241,16 +32729,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" x-sunset: "2025-08-05" patch: deprecated: true @@ -32299,18 +32793,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' x-sunset: "2025-08-05" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -32352,16 +32854,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -32408,18 +32916,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api takeSnapshot --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -32466,16 +32982,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -32521,16 +33043,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -32583,18 +33111,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32639,16 +33175,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -32694,16 +33236,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32741,16 +33289,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -32801,18 +33355,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -32861,18 +33423,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32910,16 +33480,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32966,16 +33542,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33013,16 +33595,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33069,16 +33657,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -33118,16 +33712,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -33177,16 +33777,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -33237,18 +33843,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -33303,16 +33917,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -33364,16 +33984,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -33422,16 +34048,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -33491,18 +34123,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -33543,16 +34183,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -33593,16 +34239,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" x-sunset: "2026-03-01" post: deprecated: true @@ -33651,18 +34303,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -33715,16 +34375,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" x-sunset: "2026-03-01" post: deprecated: true @@ -33775,18 +34441,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -33898,18 +34572,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createRollingIndex --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33951,16 +34633,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -34011,18 +34699,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -34072,16 +34768,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -34132,16 +34834,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -34201,18 +34909,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -34278,16 +34994,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -34330,16 +35052,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -34381,16 +35109,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -34437,18 +35171,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: deprecated: true @@ -34490,16 +35232,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -34551,18 +35299,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -34597,18 +35353,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -34661,16 +35425,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -34715,18 +35485,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -34777,16 +35555,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: deprecated: true @@ -34825,16 +35609,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" x-sunset: "2026-03-01" get: deprecated: true @@ -34873,16 +35663,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -34930,18 +35726,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" post: deprecated: true @@ -34989,18 +35793,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -35041,16 +35853,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -35096,18 +35914,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -35157,16 +35983,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -35214,16 +36046,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -35268,16 +36106,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -35329,18 +36173,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35376,16 +36228,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -35456,16 +36314,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35507,16 +36371,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -35558,18 +36428,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -35611,18 +36489,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -35665,16 +36551,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -35715,18 +36607,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -35769,16 +36669,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -35814,16 +36720,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -35874,18 +36786,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35915,16 +36835,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35953,16 +36879,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -36003,18 +36935,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -36051,16 +36991,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -36094,16 +37040,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -36150,18 +37102,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -36199,16 +37159,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -36247,18 +37213,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -36291,16 +37265,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -36335,16 +37315,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -36391,18 +37377,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36439,16 +37433,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -36499,16 +37499,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -36559,16 +37565,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -36629,18 +37641,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -36697,16 +37717,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36736,16 +37762,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -36877,18 +37909,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -36945,16 +37985,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -37008,16 +38054,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -37084,18 +38136,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37133,16 +38193,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -37198,18 +38264,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -37282,16 +38356,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -37361,16 +38441,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -37400,16 +38486,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -37460,18 +38552,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -37506,16 +38606,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -37556,18 +38662,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -37618,16 +38732,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -37670,16 +38790,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -37763,16 +38889,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -37819,16 +38951,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -37857,16 +38995,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -37925,16 +39069,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -37992,16 +39142,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -38058,16 +39214,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -38101,16 +39263,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -38159,16 +39327,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -38216,16 +39390,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -38285,18 +39465,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -38354,18 +39542,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -38401,16 +39597,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -38449,18 +39651,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -38495,18 +39705,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -38543,16 +39761,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -38591,16 +39815,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -38647,18 +39877,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -38688,16 +39926,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38732,16 +39976,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -38808,16 +40058,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -38885,16 +40141,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -38972,18 +40234,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: deprecated: true @@ -39033,18 +40303,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -39077,16 +40355,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -39118,18 +40402,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: deprecated: true @@ -39172,18 +40464,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -39226,16 +40526,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -39261,16 +40567,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -39296,16 +40608,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -39339,18 +40657,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39376,18 +40702,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -39413,18 +40747,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deferMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -39451,16 +40793,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39487,16 +40835,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39523,18 +40877,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -39602,16 +40964,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39653,16 +41021,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -39704,18 +41078,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -39753,16 +41135,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -39799,16 +41187,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -39856,18 +41250,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39897,16 +41299,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -39942,18 +41350,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -39990,16 +41406,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -40036,16 +41458,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -40092,18 +41520,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40143,16 +41579,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40200,16 +41642,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40247,18 +41695,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40296,18 +41752,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40355,16 +41819,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -40412,16 +41882,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -40468,16 +41944,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -40522,18 +42004,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40573,16 +42063,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40629,16 +42125,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -40686,16 +42188,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -40755,18 +42263,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -40820,16 +42336,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -40884,16 +42406,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -40930,18 +42458,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40970,16 +42506,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -41014,18 +42556,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -41063,16 +42613,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -41120,18 +42676,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -41176,16 +42740,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -41229,16 +42799,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -41289,18 +42865,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -41331,16 +42915,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41379,18 +42969,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -41424,16 +43022,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -41487,18 +43091,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41536,16 +43148,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -41584,16 +43202,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41623,16 +43247,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41667,16 +43297,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41714,16 +43350,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41764,16 +43406,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41840,16 +43488,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41887,16 +43541,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41936,16 +43596,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -42028,16 +43694,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -42231,16 +43903,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42295,16 +43973,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -42376,16 +44060,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42464,16 +44154,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -42504,16 +44200,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -42543,16 +44245,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -42590,18 +44298,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -42639,18 +44355,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -42689,18 +44413,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -42735,16 +44467,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42774,16 +44512,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -42820,18 +44564,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42872,16 +44624,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -42929,18 +44687,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42987,16 +44753,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43037,16 +44809,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43093,16 +44871,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -43138,16 +44922,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -43187,18 +44977,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -43238,16 +45036,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -43286,16 +45090,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -43339,18 +45149,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43381,16 +45199,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -43427,18 +45251,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -43467,16 +45299,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listStreamInstances --help post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -43511,18 +45349,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -43559,16 +45405,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -43608,16 +45460,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -43662,18 +45520,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -43731,16 +45597,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -43777,16 +45649,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -43829,18 +45707,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -43883,16 +45769,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -43931,16 +45823,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -43991,18 +45889,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44038,16 +45944,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -44091,18 +46003,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -44144,16 +46064,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -44204,18 +46130,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44242,16 +46176,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44289,18 +46229,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -44329,16 +46277,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44365,16 +46319,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44410,18 +46370,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44457,16 +46425,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44508,16 +46482,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44555,16 +46535,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -44611,18 +46597,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -44662,16 +46656,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -44711,16 +46711,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listOrganizations --help post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -44760,18 +46766,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -44810,16 +46824,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -44851,16 +46871,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -44899,18 +46925,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -44943,16 +46977,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -44988,18 +47028,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45038,16 +47086,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -45085,16 +47139,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -45141,18 +47201,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -45194,16 +47262,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -45254,18 +47328,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -45316,16 +47398,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -45373,16 +47461,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -45417,18 +47511,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -45473,16 +47575,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -45544,16 +47652,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -45600,16 +47714,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -45640,16 +47760,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -45696,16 +47822,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45744,16 +47876,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -45790,18 +47928,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -45838,18 +47984,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45886,16 +48040,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -45933,16 +48093,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -45988,18 +48154,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -46090,16 +48264,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -46143,16 +48323,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -46197,16 +48383,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -46235,16 +48427,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -46275,16 +48473,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -46312,16 +48516,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -46356,18 +48566,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46398,16 +48616,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -46444,18 +48668,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -46492,16 +48724,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -46543,18 +48781,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46597,16 +48843,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -46648,16 +48900,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -46708,18 +48966,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -46766,16 +49032,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -46828,18 +49100,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46889,16 +49169,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -46938,16 +49224,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -46981,16 +49273,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -47031,16 +49329,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -47087,18 +49391,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/users: post: description: |- @@ -47138,18 +49450,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -47186,16 +49506,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -47230,16 +49556,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-02-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json index 97c9205b80..6b92679a51 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json @@ -246,13 +246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -303,13 +308,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -366,13 +376,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -429,13 +444,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -483,13 +503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -549,13 +574,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -622,13 +652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -693,13 +728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -775,13 +815,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -838,13 +883,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -910,13 +960,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -983,13 +1038,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1057,13 +1117,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1142,13 +1207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1240,13 +1310,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] } @@ -1314,13 +1389,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ], "x-sunset": "2025-01-01" @@ -1395,13 +1475,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-01-01" @@ -1456,13 +1541,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1522,13 +1612,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1608,13 +1703,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1682,13 +1782,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1742,13 +1847,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -1800,13 +1910,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -1875,13 +1990,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -1951,13 +2071,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2021,13 +2146,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2109,13 +2239,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2184,13 +2319,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2260,13 +2400,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2337,13 +2482,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2403,13 +2553,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2472,13 +2627,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2542,13 +2702,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2613,13 +2778,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2695,13 +2865,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2780,13 +2955,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -2862,13 +3042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -2944,13 +3129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3016,13 +3206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3101,13 +3296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -3183,13 +3383,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3253,13 +3458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3319,13 +3529,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3395,13 +3610,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3485,13 +3705,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3566,13 +3791,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3623,13 +3853,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3692,13 +3927,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3749,13 +3989,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -3815,13 +4060,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -3882,13 +4132,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -3958,13 +4213,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -4032,13 +4292,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4101,13 +4366,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -4162,13 +4432,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ] }, @@ -4244,13 +4519,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ] } @@ -4301,13 +4581,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4371,13 +4656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4452,13 +4742,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4521,13 +4816,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4609,13 +4909,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4685,13 +4990,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -4765,13 +5075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -4851,13 +5166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -4931,13 +5251,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5011,13 +5336,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5094,13 +5424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5168,13 +5503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -5257,13 +5597,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5336,13 +5681,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5420,13 +5770,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5495,13 +5850,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5573,13 +5933,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5660,13 +6025,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -5744,13 +6114,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -5823,13 +6198,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -5893,13 +6273,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ], "x-sunset": "2025-08-05" @@ -5962,13 +6347,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ], "x-sunset": "2025-08-05" @@ -6045,13 +6435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ], "x-sunset": "2025-08-05" @@ -6127,13 +6522,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6208,13 +6608,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6289,13 +6694,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6371,13 +6781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6443,13 +6858,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6527,13 +6947,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6609,13 +7034,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6702,13 +7132,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -6794,13 +7229,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -6883,13 +7323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -6955,13 +7400,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7039,13 +7489,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7111,13 +7566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7195,13 +7655,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7274,13 +7739,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7362,13 +7832,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7453,13 +7928,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7549,13 +8029,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7639,13 +8124,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -7724,13 +8214,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -7826,13 +8321,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -7901,13 +8401,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -7976,13 +8481,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ], "x-sunset": "2026-03-01" @@ -8063,13 +8573,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8157,13 +8672,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ], "x-sunset": "2026-03-01" @@ -8247,13 +8767,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8423,13 +8948,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -8505,13 +9035,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -8596,13 +9131,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -8705,13 +9245,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -8793,13 +9338,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -8882,13 +9432,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -8985,13 +9540,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9064,13 +9624,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9141,13 +9706,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9226,13 +9796,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9303,13 +9878,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9394,13 +9974,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -9461,13 +10046,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -9554,13 +10144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -9636,13 +10231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -9721,13 +10321,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -9794,13 +10399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ], "x-sunset": "2026-03-01" @@ -9866,13 +10476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9952,13 +10567,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10038,13 +10658,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10109,13 +10734,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -10188,13 +10818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -10281,13 +10916,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -10366,13 +11006,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -10446,13 +11091,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -10537,13 +11187,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -10606,13 +11261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -10723,13 +11383,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -10807,13 +11472,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -10885,13 +11555,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -10951,13 +11626,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -11030,13 +11710,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -11098,13 +11783,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -11189,13 +11879,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -11249,13 +11944,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -11327,13 +12027,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -11399,13 +12104,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -11466,13 +12176,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -11553,13 +12268,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -11626,13 +12346,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -11701,13 +12426,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -11767,13 +12497,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -11834,13 +12569,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -11921,13 +12661,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -11993,13 +12738,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -12071,13 +12821,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -12150,13 +12905,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -12243,13 +13003,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -12339,13 +13104,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -12405,13 +13175,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -12635,13 +13410,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -12717,13 +13497,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -12794,13 +13579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -12891,13 +13681,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -12969,13 +13764,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -13061,13 +13861,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -13184,13 +13989,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -13304,13 +14114,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -13361,13 +14176,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -13436,13 +14256,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -13505,13 +14330,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -13583,13 +14413,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -13675,13 +14510,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -13754,13 +14594,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -13887,13 +14732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -13968,13 +14818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -14028,13 +14883,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -14134,13 +14994,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/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" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -14243,13 +15108,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/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" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -14344,13 +15214,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -14416,13 +15291,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -14501,13 +15381,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -14584,13 +15469,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -14690,13 +15580,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -14793,13 +15688,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -14863,13 +15763,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -14937,13 +15842,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15005,13 +15915,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15073,13 +15988,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -15145,13 +16065,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -15228,13 +16153,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15289,13 +16219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -15358,13 +16293,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -15445,13 +16385,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -15533,13 +16478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -15632,13 +16582,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -15712,13 +16667,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15793,13 +16753,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -15870,13 +16835,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -15936,13 +16906,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -16002,13 +16977,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -16056,13 +17036,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -16111,13 +17096,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -16177,13 +17167,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -16231,13 +17226,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -16285,13 +17285,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -16342,13 +17347,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -16399,13 +17409,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -16456,13 +17471,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -16574,13 +17594,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -16657,13 +17682,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -16736,13 +17766,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -16808,13 +17843,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -16878,13 +17918,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -16965,13 +18010,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -17025,13 +18075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -17094,13 +18149,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -17163,13 +18223,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -17233,13 +18298,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -17317,13 +18387,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -17392,13 +18467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -17483,13 +18563,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -17555,13 +18640,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -17627,13 +18717,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -17718,13 +18813,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -17803,13 +18903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -17886,13 +18991,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -17969,13 +19079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -18041,13 +19156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -18101,13 +19221,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -18170,13 +19295,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -18241,13 +19371,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -18322,13 +19457,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -18402,13 +19542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -18480,13 +19625,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -18569,13 +19719,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -18644,13 +19799,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -18728,13 +19888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -18813,13 +19978,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -18917,13 +20087,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -19011,13 +20186,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -19106,13 +20286,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -19168,13 +20353,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -19242,13 +20432,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -19314,13 +20509,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -19383,13 +20583,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -19455,13 +20660,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -19528,13 +20738,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -19594,13 +20809,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -19662,13 +20882,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -19739,13 +20964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -19816,13 +21046,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -19932,13 +21167,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -20009,13 +21249,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -20083,13 +21328,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -20208,13 +21458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -20440,13 +21695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -20526,13 +21786,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -20636,13 +21901,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -20762,13 +22032,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -20825,13 +22100,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -20886,13 +22166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -20959,13 +22244,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -21032,13 +22322,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -21104,13 +22399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -21170,13 +22470,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -21236,13 +22541,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -21308,13 +22618,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -21389,13 +22704,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -21476,13 +22796,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -21560,13 +22885,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -21641,13 +22971,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -21723,13 +23058,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -21792,13 +23132,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -21865,13 +23210,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -21940,13 +23290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -22013,13 +23368,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -22094,13 +23454,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -22160,13 +23525,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" } ] }, @@ -22230,13 +23600,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -22300,13 +23675,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -22367,13 +23747,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -22448,13 +23833,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] }, @@ -22531,13 +23921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -22594,13 +23989,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -22666,13 +24066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -22729,13 +24134,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -22798,13 +24208,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -22870,13 +24285,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -22945,13 +24365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -23029,13 +24454,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -23128,13 +24558,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -23203,13 +24638,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -23284,13 +24724,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -23365,13 +24810,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -23438,13 +24888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -23531,13 +24986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -23606,13 +25066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -23688,13 +25153,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -23764,13 +25234,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -23855,13 +25330,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -23912,13 +25392,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -23981,13 +25466,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -24035,13 +25525,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -24092,13 +25587,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -24163,13 +25663,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -24232,13 +25737,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -24316,13 +25826,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -24388,13 +25903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -24474,13 +25994,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -24554,13 +26079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -24629,13 +26159,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -24695,13 +26230,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -24759,13 +26299,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -24834,13 +26379,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -24904,13 +26454,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -24974,13 +26529,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -25047,13 +26607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -25118,13 +26683,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -25203,13 +26773,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -25285,13 +26860,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -25381,13 +26961,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -25471,13 +27056,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -25556,13 +27146,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -25624,13 +27219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -25705,13 +27305,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -25810,13 +27415,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -25891,13 +27501,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -25954,13 +27569,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -26034,13 +27654,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -26109,13 +27734,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -26181,13 +27811,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -26253,13 +27888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -26325,13 +27965,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -26395,13 +28040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -26479,13 +28129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -26627,13 +28282,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -26687,13 +28347,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -26765,13 +28430,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -26836,13 +28506,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -26899,13 +28574,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -26956,13 +28636,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -27025,13 +28710,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -27091,13 +28781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" } ] }, @@ -27160,13 +28855,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -27226,13 +28926,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -27293,13 +28998,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -27374,13 +29084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -27449,13 +29164,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccountProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" } ] } @@ -27529,13 +29249,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" } ] } @@ -27604,13 +29329,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" } ] } @@ -27667,13 +29397,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -27739,13 +29474,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -27815,13 +29555,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -27894,13 +29639,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -27970,13 +29720,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -28049,13 +29804,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -28126,13 +29886,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -28217,13 +29982,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -28305,13 +30075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -28399,13 +30174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -28487,13 +30267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -28559,13 +30344,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -28634,13 +30424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -28720,13 +30515,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -28788,13 +30588,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-10-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -28855,13 +30660,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -28924,13 +30734,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml index da7634fc65..43ed27b762 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml @@ -29078,16 +29078,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -29115,16 +29121,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -29153,16 +29165,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -29191,16 +29209,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -29227,16 +29251,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -29268,16 +29298,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -29317,16 +29353,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -29365,16 +29407,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -29420,18 +29468,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -29462,16 +29518,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -29508,18 +29570,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -29558,16 +29628,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -29607,16 +29683,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -29663,18 +29745,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -29728,16 +29818,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: get: deprecated: true @@ -29777,16 +29873,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" x-sunset: "2025-01-01" patch: deprecated: true @@ -29834,18 +29936,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' x-sunset: "2025-01-01" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: @@ -29876,16 +29986,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -29916,16 +30032,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -29973,18 +30095,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -30013,16 +30143,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -30050,16 +30186,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -30098,18 +30240,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -30148,18 +30298,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -30192,16 +30350,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -30246,18 +30410,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -30302,16 +30474,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -30352,16 +30530,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -30402,16 +30586,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -30444,16 +30634,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30491,18 +30687,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -30542,16 +30746,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -30592,16 +30802,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30651,18 +30867,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -30714,18 +30938,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -30770,16 +31002,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -30823,16 +31061,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -30873,16 +31117,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: deprecated: true description: |- @@ -30932,18 +31182,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -30988,16 +31246,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -31030,16 +31294,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -31072,18 +31342,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createProjectApiKey --help /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31124,16 +31402,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -31180,18 +31464,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -31235,18 +31527,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -31273,16 +31573,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -31317,18 +31623,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31355,16 +31669,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -31397,18 +31717,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true @@ -31439,16 +31767,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" x-sunset: "2025-05-30" post: deprecated: true @@ -31489,18 +31823,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -31541,16 +31883,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: deprecated: true description: Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31588,16 +31936,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: @@ -31627,16 +31981,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateDataProtectionSettings @@ -31680,18 +32040,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31718,16 +32086,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -31763,18 +32137,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -31818,16 +32200,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31863,16 +32251,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -31921,18 +32315,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: deprecated: true @@ -31969,16 +32371,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" x-sunset: "2026-03-01" post: deprecated: true @@ -32021,18 +32429,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -32078,16 +32494,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: deprecated: true description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -32127,16 +32549,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -32186,18 +32614,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: @@ -32237,16 +32673,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -32293,18 +32735,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -32345,16 +32795,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32393,16 +32849,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -32453,18 +32915,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32511,16 +32981,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -32564,16 +33040,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: deprecated: true @@ -32611,16 +33093,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" x-sunset: "2025-08-05" get: deprecated: true @@ -32657,16 +33145,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" x-sunset: "2025-08-05" patch: deprecated: true @@ -32715,18 +33209,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' x-sunset: "2025-08-05" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -32768,16 +33270,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -32824,18 +33332,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -32882,16 +33398,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -32937,16 +33459,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -32999,18 +33527,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33055,16 +33591,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -33110,16 +33652,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33157,16 +33705,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -33217,18 +33771,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -33277,18 +33839,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33326,16 +33896,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33382,16 +33958,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33429,16 +34011,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33485,16 +34073,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -33534,16 +34128,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -33593,16 +34193,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -33653,18 +34259,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -33719,16 +34333,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -33780,16 +34400,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -33838,16 +34464,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -33907,18 +34539,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -33959,16 +34599,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -34009,16 +34655,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" x-sunset: "2026-03-01" post: deprecated: true @@ -34067,18 +34719,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -34131,16 +34791,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" x-sunset: "2026-03-01" post: deprecated: true @@ -34191,18 +34857,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -34314,18 +34988,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34367,16 +35049,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -34427,18 +35115,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -34488,16 +35184,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -34548,16 +35250,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -34617,18 +35325,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -34694,16 +35410,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -34746,16 +35468,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -34797,16 +35525,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -34853,18 +35587,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: deprecated: true @@ -34906,16 +35648,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -34967,18 +35715,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -35013,18 +35769,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -35077,16 +35841,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -35131,18 +35901,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createLegacyBackupRestoreJob --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -35193,16 +35971,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: deprecated: true @@ -35241,16 +36025,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" x-sunset: "2026-03-01" get: deprecated: true @@ -35289,16 +36079,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -35346,18 +36142,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" post: deprecated: true @@ -35405,18 +36209,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -35457,16 +36269,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -35512,18 +36330,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -35573,16 +36399,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -35630,16 +36462,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -35684,16 +36522,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -35745,18 +36589,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35792,16 +36644,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -35872,16 +36730,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35923,16 +36787,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -35974,18 +36844,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -36027,18 +36905,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -36081,16 +36967,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -36131,18 +37023,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -36185,16 +37085,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -36230,16 +37136,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -36290,18 +37202,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36331,16 +37251,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36369,16 +37295,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -36419,18 +37351,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -36467,16 +37407,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -36510,16 +37456,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -36566,18 +37518,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -36615,16 +37575,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -36663,18 +37629,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -36707,16 +37681,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -36751,16 +37731,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -36807,18 +37793,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36855,16 +37849,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -36915,16 +37915,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -36975,16 +37981,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -37045,18 +38057,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -37113,16 +38133,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37152,16 +38178,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -37293,18 +38325,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -37361,16 +38401,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -37424,16 +38470,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -37500,18 +38552,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37549,16 +38609,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -37614,18 +38680,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -37698,16 +38772,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -37777,16 +38857,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -37816,16 +38902,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -37876,18 +38968,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -37922,16 +39022,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -37972,18 +39078,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -38034,16 +39148,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -38086,16 +39206,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -38179,16 +39305,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -38235,16 +39367,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -38273,16 +39411,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -38341,16 +39485,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -38408,16 +39558,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -38474,16 +39630,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -38517,16 +39679,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -38575,16 +39743,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -38632,16 +39806,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -38701,18 +39881,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -38770,18 +39958,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -38817,16 +40013,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -38865,18 +40067,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -38911,18 +40121,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -38959,16 +40177,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -39007,16 +40231,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -39063,18 +40293,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -39104,16 +40342,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39148,16 +40392,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -39224,16 +40474,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -39301,16 +40557,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -39388,18 +40650,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: deprecated: true @@ -39449,18 +40719,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -39493,16 +40771,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -39534,18 +40818,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: deprecated: true @@ -39588,18 +40880,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -39642,16 +40942,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -39677,16 +40983,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -39712,16 +41024,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -39755,18 +41073,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39792,18 +41118,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -39829,18 +41163,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deferMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -39867,16 +41209,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39903,16 +41251,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -39939,18 +41293,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -40018,16 +41380,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40069,16 +41437,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -40120,18 +41494,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -40169,16 +41551,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -40215,16 +41603,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -40272,18 +41666,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40313,16 +41715,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -40358,18 +41766,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -40406,16 +41822,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -40452,16 +41874,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -40508,18 +41936,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40559,16 +41995,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40616,16 +42058,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40663,18 +42111,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40712,18 +42168,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40771,16 +42235,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -40828,16 +42298,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -40884,16 +42360,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -40938,18 +42420,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40989,16 +42479,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41045,16 +42541,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -41102,16 +42604,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -41171,18 +42679,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -41236,16 +42752,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -41300,16 +42822,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -41346,18 +42874,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41386,16 +42922,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -41430,18 +42972,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -41479,16 +43029,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -41536,18 +43092,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -41592,16 +43156,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -41645,16 +43215,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -41705,18 +43281,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -41747,16 +43331,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41795,18 +43385,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -41840,16 +43438,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -41903,18 +43507,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41952,16 +43564,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -42000,16 +43618,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42039,16 +43663,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42083,16 +43713,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42130,16 +43766,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42180,16 +43822,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42256,16 +43904,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42303,16 +43957,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42352,16 +44012,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -42444,16 +44110,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -42647,16 +44319,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42711,16 +44389,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -42792,16 +44476,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42880,16 +44570,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -42920,16 +44616,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -42959,16 +44661,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -43006,18 +44714,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -43055,18 +44771,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -43105,18 +44829,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -43151,16 +44883,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43190,16 +44928,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -43236,18 +44980,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43288,16 +45040,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -43345,18 +45103,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43403,16 +45169,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43453,16 +45225,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43509,16 +45287,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -43554,16 +45338,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -43603,18 +45393,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -43654,16 +45452,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -43702,16 +45506,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -43755,18 +45565,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns list of Service Accounts for a project with service account details. @@ -43797,16 +45615,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" post: description: Creates and assigns the specified Service Account to the specified Project. operationId: createProjectServiceAccount @@ -43842,18 +45666,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: delete: description: Removes one Service Account from the specified project. @@ -43889,16 +45721,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" get: description: Get project Service Account Details. operationId: getProjectServiceAccount @@ -43932,16 +45770,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account in Project. operationId: updateProjectServiceAccount @@ -43984,18 +45828,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' post: description: Assigns the specified organization Service Account to the specified project. operationId: addProjectServiceAccount @@ -44040,18 +45892,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44082,16 +45942,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -44128,18 +45994,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -44168,16 +46042,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -44212,18 +46092,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -44260,16 +46148,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -44309,16 +46203,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -44363,18 +46263,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -44432,16 +46340,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -44478,16 +46392,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -44530,18 +46450,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -44584,16 +46512,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI - lang: cURL - source: atlas api deleteStreamConnection --help get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -44632,16 +46566,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -44692,18 +46632,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44739,16 +46687,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -44792,18 +46746,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -44845,16 +46807,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -44905,18 +46873,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44943,16 +46919,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44990,18 +46972,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -45030,16 +47020,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45066,16 +47062,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45111,18 +47113,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45158,16 +47168,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45209,16 +47225,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45256,16 +47278,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -45312,18 +47340,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -45363,16 +47399,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -45412,16 +47454,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -45461,18 +47509,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -45511,16 +47567,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -45552,16 +47614,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -45600,18 +47668,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -45644,16 +47720,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -45689,18 +47771,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -45739,16 +47829,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -45786,16 +47882,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getApiKey --help 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. externalDocs: @@ -45842,18 +47944,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -45895,16 +48005,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -45955,18 +48071,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -46017,16 +48141,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -46074,16 +48204,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -46118,18 +48254,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -46174,16 +48318,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -46245,16 +48395,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -46301,16 +48457,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -46341,16 +48503,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -46397,16 +48565,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46445,16 +48619,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -46491,18 +48671,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -46539,18 +48727,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46587,16 +48783,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -46634,16 +48836,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -46689,18 +48897,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -46791,16 +49007,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -46844,16 +49066,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -46898,16 +49126,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -46936,16 +49170,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -46976,16 +49216,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -47013,16 +49259,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -47057,18 +49309,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns list of Service Accounts with service account details. @@ -47099,16 +49359,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" post: description: Create Service Account containing client id and client secrets. operationId: createServiceAccount @@ -47143,18 +49409,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: delete: description: Delete Service Account. @@ -47187,16 +49461,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" get: description: Get Service Account Details. operationId: getServiceAccount @@ -47230,16 +49510,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account. operationId: updateServiceAccount @@ -47282,18 +49568,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: get: description: Returns list of Service Account projects. @@ -47330,16 +49624,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccountProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: post: description: Create Service Account secret. @@ -47381,18 +49681,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: delete: description: Delete Service Account Secret. @@ -47431,16 +49739,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47471,16 +49785,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -47517,18 +49837,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -47565,16 +49893,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -47616,18 +49950,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47670,16 +50012,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -47721,16 +50069,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -47781,18 +50135,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -47839,16 +50201,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -47901,18 +50269,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47962,16 +50338,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -48011,16 +50393,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -48054,16 +50442,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -48104,16 +50498,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -48160,18 +50560,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/users: post: description: |- @@ -48211,18 +50619,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ - --header "Content-Type: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -48259,16 +50675,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -48303,16 +50725,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-10-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-10-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json index 1f6684c720..36858b9532 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json @@ -250,13 +250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -307,13 +312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -370,13 +380,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -433,13 +448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -487,13 +507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -553,13 +578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -626,13 +656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -697,13 +732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -779,13 +819,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -842,13 +887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -914,13 +964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -987,13 +1042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1061,13 +1121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1146,13 +1211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1244,13 +1314,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] }, @@ -1316,13 +1391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" } ] } @@ -1383,13 +1463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteIdentityProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" } ] }, @@ -1454,13 +1539,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ] }, @@ -1533,13 +1623,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ] } @@ -1600,13 +1695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api revokeJwksFromIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" } ] } @@ -1660,13 +1760,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1726,13 +1831,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1812,13 +1922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1886,13 +2001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1946,13 +2066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -2004,13 +2129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -2079,13 +2209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -2155,13 +2290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2225,13 +2365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2313,13 +2458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2388,13 +2538,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2464,13 +2619,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2541,13 +2701,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2607,13 +2772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2676,13 +2846,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2746,13 +2921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2817,13 +2997,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2899,13 +3084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2984,13 +3174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -3066,13 +3261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -3148,13 +3348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3220,13 +3425,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3305,13 +3515,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -3387,13 +3602,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3457,13 +3677,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3523,13 +3748,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3599,13 +3829,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3689,13 +3924,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3770,13 +4010,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3827,13 +4072,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3896,13 +4146,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3953,13 +4208,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -4019,13 +4279,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -4086,13 +4351,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -4162,13 +4432,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -4236,13 +4511,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4305,13 +4585,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ], "x-sunset": "2025-05-30" @@ -4366,13 +4651,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ] }, @@ -4448,13 +4738,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ] } @@ -4505,13 +4800,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4575,13 +4875,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4656,13 +4961,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4725,13 +5035,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4813,13 +5128,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4889,13 +5209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -4969,13 +5294,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5055,13 +5385,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -5135,13 +5470,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5215,13 +5555,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5298,13 +5643,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5372,13 +5722,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -5461,13 +5816,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5540,13 +5900,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5624,13 +5989,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5699,13 +6069,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5777,13 +6152,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5864,13 +6244,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -5948,13 +6333,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -6027,13 +6417,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -6097,13 +6492,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ], "x-sunset": "2025-08-05" @@ -6166,13 +6566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ], "x-sunset": "2025-08-05" @@ -6249,13 +6654,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ], "x-sunset": "2025-08-05" @@ -6331,13 +6741,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6412,13 +6827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6493,13 +6913,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6575,13 +7000,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6647,13 +7077,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6731,13 +7166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6813,13 +7253,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6906,13 +7351,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -6998,13 +7448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -7087,13 +7542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -7159,13 +7619,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7243,13 +7708,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7315,13 +7785,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7399,13 +7874,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7478,13 +7958,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7566,13 +8051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7638,13 +8128,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPinnedNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" } ] }, @@ -7730,13 +8225,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPatch --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] }, @@ -7822,13 +8322,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPut --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] } @@ -7905,13 +8410,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" } ] } @@ -7996,13 +8506,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8092,13 +8607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8182,13 +8702,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -8267,13 +8792,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8369,13 +8899,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8444,13 +8979,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -8519,13 +9059,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ], "x-sunset": "2026-03-01" @@ -8606,13 +9151,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8700,13 +9250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ], "x-sunset": "2026-03-01" @@ -8790,13 +9345,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8966,13 +9526,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -9048,13 +9613,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -9139,13 +9709,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -9248,13 +9823,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -9336,13 +9916,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -9425,13 +10010,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -9528,13 +10118,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9607,13 +10202,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9684,13 +10284,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9769,13 +10374,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9846,13 +10456,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -9937,13 +10552,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10004,13 +10624,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -10097,13 +10722,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -10179,13 +10809,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -10264,13 +10899,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -10337,13 +10977,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ], "x-sunset": "2026-03-01" @@ -10409,13 +11054,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -10495,13 +11145,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10581,13 +11236,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10652,13 +11312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -10731,13 +11396,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -10824,13 +11494,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -10909,13 +11584,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -10989,13 +11669,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -11080,13 +11765,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -11149,13 +11839,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -11238,13 +11933,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" } ] } @@ -11380,13 +12080,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -11497,13 +12202,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -11557,13 +12267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" } ] } @@ -11641,13 +12356,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -11719,13 +12439,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -11785,13 +12510,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -11864,13 +12594,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -11932,13 +12667,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -12023,13 +12763,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -12083,13 +12828,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -12161,13 +12911,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -12233,13 +12988,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -12300,13 +13060,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -12387,13 +13152,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -12460,13 +13230,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -12535,13 +13310,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -12601,13 +13381,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -12668,13 +13453,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -12755,13 +13545,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -12827,13 +13622,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -12905,13 +13705,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -12984,13 +13789,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -13077,13 +13887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -13173,13 +13988,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -13239,13 +14059,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -13469,13 +14294,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -13551,13 +14381,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -13628,13 +14463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -13725,13 +14565,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -13803,13 +14648,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -13895,13 +14745,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -14018,13 +14873,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -14138,13 +14998,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -14195,13 +15060,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -14270,13 +15140,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -14339,13 +15214,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -14417,13 +15297,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -14509,13 +15394,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -14588,13 +15478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -14721,13 +15616,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -14802,13 +15702,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -14862,13 +15767,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -14968,13 +15878,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -15077,13 +15992,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -15178,13 +16098,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -15250,13 +16175,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -15335,13 +16265,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -15418,13 +16353,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -15524,13 +16464,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -15627,13 +16572,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -15697,13 +16647,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -15771,13 +16726,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15839,13 +16799,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -15907,13 +16872,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -15979,13 +16949,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -16062,13 +17037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -16123,13 +17103,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -16192,13 +17177,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -16279,13 +17269,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -16367,13 +17362,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -16466,13 +17466,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -16546,13 +17551,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -16627,13 +17637,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ], "x-sunset": "2025-05-30" @@ -16704,13 +17719,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -16770,13 +17790,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -16836,13 +17861,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -16890,13 +17920,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -16945,13 +17980,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -17011,13 +18051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -17065,13 +18110,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -17119,13 +18169,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -17176,13 +18231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -17233,13 +18293,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -17290,13 +18355,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -17408,13 +18478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -17491,13 +18566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -17570,13 +18650,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -17642,13 +18727,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -17712,13 +18802,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -17799,13 +18894,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -17859,13 +18959,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -17928,13 +19033,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -17997,13 +19107,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -18067,13 +19182,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -18151,13 +19271,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -18226,13 +19351,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -18317,13 +19447,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -18389,13 +19524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -18461,13 +19601,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -18552,13 +19697,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -18637,13 +19787,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -18720,13 +19875,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -18803,13 +19963,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -18875,13 +20040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -18935,13 +20105,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -19004,13 +20179,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -19075,13 +20255,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -19156,13 +20341,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -19236,13 +20426,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -19314,13 +20509,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -19403,13 +20603,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -19478,13 +20683,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -19562,13 +20772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -19647,13 +20862,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -19751,13 +20971,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -19845,13 +21070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -19940,13 +21170,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -20002,13 +21237,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -20076,13 +21316,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -20148,13 +21393,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -20217,13 +21467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -20289,13 +21544,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -20362,13 +21622,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -20428,13 +21693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -20496,13 +21766,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -20562,13 +21837,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" } ] } @@ -20639,13 +21919,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -20716,13 +22001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -20832,13 +22122,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -20909,13 +22204,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -20983,13 +22283,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -21108,13 +22413,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -21340,13 +22650,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -21426,13 +22741,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -21536,13 +22856,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -21662,13 +22987,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -21779,13 +23109,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -21842,13 +23177,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -21903,13 +23243,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -21976,13 +23321,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -22049,13 +23399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -22121,13 +23476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -22187,13 +23547,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -22253,13 +23618,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -22325,13 +23695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -22406,13 +23781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -22493,13 +23873,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -22577,13 +23962,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -22658,13 +24048,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -22740,13 +24135,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -22809,13 +24209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -22882,13 +24287,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -22957,13 +24367,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -23030,13 +24445,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -23111,13 +24531,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -23177,13 +24602,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" } ] }, @@ -23247,13 +24677,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -23317,13 +24752,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -23384,13 +24824,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -23465,13 +24910,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] }, @@ -23548,13 +24998,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -23611,13 +25066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -23683,13 +25143,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -23746,13 +25211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -23815,13 +25285,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -23887,13 +25362,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -23962,13 +25442,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -24046,13 +25531,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -24145,13 +25635,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -24220,13 +25715,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -24301,13 +25801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -24382,13 +25887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -24455,13 +25965,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -24548,13 +26063,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -24623,13 +26143,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -24705,13 +26230,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -24781,13 +26311,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -24872,13 +26407,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -24929,13 +26469,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -24998,13 +26543,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -25052,13 +26602,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -25109,13 +26664,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -25180,13 +26740,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -25249,13 +26814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -25333,13 +26903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -25405,13 +26980,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -25491,13 +27071,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -25571,13 +27156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -25646,13 +27236,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -25712,13 +27307,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -25776,13 +27376,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -25851,13 +27456,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -25921,13 +27531,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -25991,13 +27606,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -26064,13 +27684,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -26135,13 +27760,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -26220,13 +27850,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -26302,13 +27937,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -26398,13 +28038,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -26488,13 +28133,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -26573,13 +28223,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -26641,13 +28296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -26722,13 +28382,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -26827,13 +28492,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -26908,13 +28578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -26971,13 +28646,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -27051,13 +28731,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -27126,13 +28811,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -27198,13 +28888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -27270,13 +28965,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -27342,13 +29042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -27412,13 +29117,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -27496,13 +29206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -27644,13 +29359,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -27704,13 +29424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -27782,13 +29507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -27853,13 +29583,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -27916,13 +29651,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -27973,13 +29713,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -28042,13 +29787,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -28108,13 +29858,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" } ] }, @@ -28177,13 +29932,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -28243,13 +30003,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -28310,13 +30075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -28391,13 +30161,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -28466,13 +30241,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccountProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" } ] } @@ -28546,13 +30326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" } ] } @@ -28621,13 +30406,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" } ] } @@ -28684,13 +30474,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -28756,13 +30551,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -28832,13 +30632,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -28911,13 +30716,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -28987,13 +30797,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -29066,13 +30881,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -29143,13 +30963,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -29234,13 +31059,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -29322,13 +31152,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -29416,13 +31251,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -29504,13 +31344,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -29576,13 +31421,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -29651,13 +31501,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -29737,13 +31592,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -29780,13 +31640,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllControlPlaneIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" } ] } @@ -29848,13 +31713,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/vnd.atlas.2023-11-15+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -29915,13 +31785,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -29984,13 +31859,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml index d3cc70dc82..361a51df42 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml @@ -29599,16 +29599,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -29636,16 +29642,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -29674,16 +29686,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -29712,16 +29730,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -29748,16 +29772,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -29789,16 +29819,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -29838,16 +29874,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -29886,16 +29928,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -29941,18 +29989,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -29983,16 +30039,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -30029,18 +30091,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30079,16 +30149,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -30128,16 +30204,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -30184,18 +30266,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30249,16 +30339,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30299,18 +30395,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/)." @@ -30345,16 +30449,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' operationId: getIdentityProvider @@ -30392,16 +30502,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30447,18 +30563,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks)." @@ -30493,16 +30617,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api revokeJwksFromIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30532,16 +30662,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -30572,16 +30708,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -30629,18 +30771,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -30669,16 +30819,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -30706,16 +30862,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -30754,18 +30916,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -30804,18 +30974,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -30848,16 +31026,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -30902,18 +31086,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -30958,16 +31150,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI - lang: cURL - source: atlas api deleteProjectIpAccessList --help 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 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. externalDocs: @@ -31008,16 +31206,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -31058,16 +31262,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -31100,16 +31310,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31147,18 +31363,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -31198,16 +31422,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31248,16 +31478,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31307,18 +31543,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31370,18 +31614,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -31426,16 +31678,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -31479,16 +31737,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -31529,16 +31793,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: deprecated: true description: |- @@ -31588,18 +31858,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: @@ -31644,16 +31922,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -31686,16 +31970,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -31728,18 +32018,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31780,16 +32078,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -31836,18 +32140,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -31891,18 +32203,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -31929,16 +32249,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -31973,18 +32299,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32011,16 +32345,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -32053,18 +32393,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true @@ -32095,16 +32443,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" x-sunset: "2025-05-30" post: deprecated: true @@ -32145,18 +32499,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: @@ -32197,16 +32559,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: deprecated: true description: Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32244,16 +32612,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: @@ -32283,16 +32657,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateDataProtectionSettings @@ -32336,18 +32716,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32374,16 +32762,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -32419,18 +32813,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -32474,16 +32876,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32519,16 +32927,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -32577,18 +32991,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: deprecated: true @@ -32625,16 +33047,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" x-sunset: "2026-03-01" post: deprecated: true @@ -32677,18 +33105,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -32734,16 +33170,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: deprecated: true description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -32783,16 +33225,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -32842,18 +33290,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -32944,16 +33400,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. @@ -33001,16 +33463,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33049,16 +33517,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -33105,18 +33579,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33157,16 +33639,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33205,16 +33693,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -33265,18 +33759,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33323,16 +33825,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -33376,16 +33884,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: deprecated: true @@ -33423,16 +33937,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" x-sunset: "2025-08-05" get: deprecated: true @@ -33469,16 +33989,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" x-sunset: "2025-08-05" patch: deprecated: true @@ -33527,18 +34053,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' x-sunset: "2025-08-05" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -33580,16 +34114,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -33636,18 +34176,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -33694,16 +34242,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -33749,16 +34303,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -33811,18 +34371,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33867,16 +34435,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -33922,16 +34496,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -33969,16 +34549,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -34029,18 +34615,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -34089,18 +34683,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34138,16 +34740,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34194,16 +34802,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34241,16 +34855,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34297,16 +34917,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -34346,16 +34972,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -34405,16 +35037,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. @@ -34453,16 +35091,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPinnedNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster operationId: pinNamespacesPatch @@ -34514,18 +35158,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPatch --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' 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. operationId: pinNamespacesPut @@ -34577,18 +35229,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPut --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster @@ -34634,18 +35294,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -34696,18 +35364,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -34762,16 +35438,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -34823,16 +35505,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -34881,16 +35569,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -34950,18 +35644,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -35002,16 +35704,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -35052,16 +35760,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" x-sunset: "2026-03-01" post: deprecated: true @@ -35110,18 +35824,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -35174,16 +35896,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" x-sunset: "2026-03-01" post: deprecated: true @@ -35234,18 +35962,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -35357,18 +36093,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35410,16 +36154,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -35470,18 +36220,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -35531,16 +36289,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -35591,16 +36355,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -35660,18 +36430,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -35737,16 +36515,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -35789,16 +36573,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -35840,16 +36630,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -35896,18 +36692,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: deprecated: true @@ -35949,16 +36753,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -36010,18 +36820,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -36056,18 +36874,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -36120,16 +36946,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -36174,18 +37006,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -36236,16 +37076,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: deprecated: true @@ -36284,16 +37130,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" x-sunset: "2026-03-01" get: deprecated: true @@ -36332,16 +37184,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -36389,18 +37247,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api updateAtlasSearchDeployment --help x-sunset: "2026-03-01" post: deprecated: true @@ -36448,18 +37314,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: @@ -36500,16 +37374,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -36555,18 +37435,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -36616,16 +37504,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -36673,16 +37567,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -36727,16 +37627,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -36788,18 +37694,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36835,16 +37749,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -36915,16 +37835,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36966,16 +37892,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -37017,18 +37949,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -37070,18 +38010,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. @@ -37111,16 +38059,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -37163,16 +38117,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -37213,18 +38173,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -37267,16 +38235,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -37312,16 +38286,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -37372,18 +38352,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37413,16 +38401,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37451,16 +38445,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -37501,18 +38501,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -37549,16 +38557,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -37592,16 +38606,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -37648,18 +38668,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -37697,16 +38725,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -37745,18 +38779,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -37789,16 +38831,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -37833,16 +38881,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -37889,18 +38943,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37937,16 +38999,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -37997,16 +39065,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -38057,16 +39131,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -38127,18 +39207,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -38195,16 +39283,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38234,16 +39328,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -38375,18 +39475,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -38443,16 +39551,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -38506,16 +39620,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -38582,18 +39702,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38631,16 +39759,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -38696,18 +39830,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -38780,16 +39922,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -38859,16 +40007,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -38898,16 +40052,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -38958,18 +40118,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -39004,16 +40172,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -39054,18 +40228,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -39116,16 +40298,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -39168,16 +40356,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -39261,16 +40455,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -39317,16 +40517,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -39355,16 +40561,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -39423,16 +40635,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -39490,16 +40708,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -39556,16 +40780,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -39599,16 +40829,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -39657,16 +40893,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -39714,16 +40956,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -39783,18 +41031,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -39852,18 +41108,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -39899,16 +41163,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -39947,18 +41217,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -39993,18 +41271,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -40041,16 +41327,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -40089,16 +41381,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -40145,18 +41443,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -40186,16 +41492,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40230,16 +41542,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -40306,16 +41624,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -40383,16 +41707,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -40470,18 +41800,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: deprecated: true @@ -40531,18 +41869,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: @@ -40575,16 +41921,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -40616,18 +41968,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api cutoverMigration --help /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: deprecated: true @@ -40670,18 +42030,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' x-sunset: "2025-05-30" /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: @@ -40724,16 +42092,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -40759,16 +42133,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -40794,16 +42174,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -40837,18 +42223,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40874,18 +42268,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -40911,18 +42313,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deferMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -40949,16 +42359,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -40985,16 +42401,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -41021,18 +42443,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -41100,16 +42530,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41151,16 +42587,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -41202,18 +42644,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -41251,16 +42701,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -41297,16 +42753,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -41354,18 +42816,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41395,16 +42865,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -41440,18 +42916,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -41488,16 +42972,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -41534,16 +43024,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -41590,18 +43086,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41641,16 +43145,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41698,16 +43208,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41745,18 +43261,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41794,18 +43318,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41853,16 +43385,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -41910,16 +43448,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -41966,16 +43510,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -42020,18 +43570,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42071,16 +43629,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42127,16 +43691,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -42184,16 +43754,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -42253,18 +43829,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -42318,16 +43902,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -42382,16 +43972,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -42428,18 +44024,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42468,16 +44072,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -42512,18 +44122,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -42561,16 +44179,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -42618,18 +44242,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -42674,16 +44306,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -42727,16 +44365,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -42787,18 +44431,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -42829,16 +44481,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42877,18 +44535,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -42922,16 +44588,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -42985,18 +44657,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43034,16 +44714,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -43082,16 +44768,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43121,16 +44813,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43165,16 +44863,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace @@ -43244,16 +44948,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. @@ -43283,16 +44993,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForHost --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43330,16 +45046,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43380,16 +45102,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43456,16 +45184,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43503,16 +45237,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43552,16 +45292,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -43644,16 +45390,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -43847,16 +45599,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43911,16 +45669,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -43992,16 +45756,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44080,16 +45850,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -44120,16 +45896,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -44159,16 +45941,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -44206,18 +45994,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -44255,18 +46051,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -44305,18 +46109,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -44351,16 +46163,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44390,16 +46208,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -44436,18 +46260,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44488,16 +46320,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -44545,18 +46383,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44603,16 +46449,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44653,16 +46505,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44709,16 +46567,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -44754,16 +46618,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -44803,18 +46673,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -44854,16 +46732,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -44902,16 +46786,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -44955,18 +46845,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns list of Service Accounts for a project with service account details. @@ -44997,16 +46895,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" post: description: Creates and assigns the specified Service Account to the specified Project. operationId: createProjectServiceAccount @@ -45042,18 +46946,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: delete: description: Removes one Service Account from the specified project. @@ -45089,16 +47001,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" get: description: Get project Service Account Details. operationId: getProjectServiceAccount @@ -45132,16 +47050,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account in Project. operationId: updateProjectServiceAccount @@ -45184,18 +47108,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' post: description: Assigns the specified organization Service Account to the specified project. operationId: addProjectServiceAccount @@ -45240,18 +47172,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45282,16 +47222,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -45328,18 +47274,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -45368,16 +47322,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -45412,18 +47372,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -45460,16 +47428,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -45509,16 +47483,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -45563,18 +47543,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -45632,16 +47620,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -45678,16 +47672,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -45730,18 +47730,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -45784,16 +47792,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -45832,16 +47846,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getStreamConnection --help patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -45892,18 +47912,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45939,16 +47967,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -45992,18 +48026,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -46045,16 +48087,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -46105,18 +48153,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46143,16 +48199,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46190,18 +48252,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -46230,16 +48300,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46266,16 +48342,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46311,18 +48393,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46358,16 +48448,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46409,16 +48505,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46456,16 +48558,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -46512,18 +48620,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -46563,16 +48679,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -46612,16 +48734,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -46661,18 +48789,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -46711,16 +48847,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -46752,16 +48894,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -46800,18 +48948,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -46844,16 +49000,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -46889,18 +49051,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -46939,16 +49109,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -46986,16 +49162,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -47042,18 +49224,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api updateApiKey --help /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -47095,16 +49285,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -47155,18 +49351,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -47217,16 +49421,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -47274,16 +49484,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -47318,18 +49534,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -47374,16 +49598,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -47445,16 +49675,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -47501,16 +49737,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -47541,16 +49783,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -47597,16 +49845,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47645,16 +49899,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -47691,18 +49951,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -47739,18 +50007,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47787,16 +50063,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -47834,16 +50116,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -47889,18 +50177,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -47991,16 +50287,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -48044,16 +50346,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -48098,16 +50406,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -48136,16 +50450,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -48176,16 +50496,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -48213,16 +50539,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -48257,18 +50589,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns list of Service Accounts with service account details. @@ -48299,16 +50639,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" post: description: Create Service Account containing client id and client secrets. operationId: createServiceAccount @@ -48343,18 +50689,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: delete: description: Delete Service Account. @@ -48387,16 +50741,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" get: description: Get Service Account Details. operationId: getServiceAccount @@ -48430,16 +50790,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account. operationId: updateServiceAccount @@ -48482,18 +50848,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: get: description: Returns list of Service Account projects. @@ -48530,16 +50904,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccountProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: post: description: Create Service Account secret. @@ -48581,18 +50961,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: delete: description: Delete Service Account Secret. @@ -48631,16 +51019,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48671,16 +51065,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -48717,18 +51117,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -48765,16 +51173,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -48816,18 +51230,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48870,16 +51292,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -48921,16 +51349,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -48981,18 +51415,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -49039,16 +51481,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -49101,18 +51549,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49162,16 +51618,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -49211,16 +51673,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -49254,16 +51722,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -49304,16 +51778,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -49360,18 +51840,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access). @@ -49392,16 +51880,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllControlPlaneIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" /api/atlas/v2/users: post: description: |- @@ -49441,18 +51935,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ - --header "Content-Type: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -49489,16 +51991,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -49533,16 +52041,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2023-11-15+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2023-11-15+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json index 268c1beb70..75da3ab25f 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json @@ -250,13 +250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -307,13 +312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -370,13 +380,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -433,13 +448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -487,13 +507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -553,13 +578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -626,13 +656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -697,13 +732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -779,13 +819,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -842,13 +887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -914,13 +964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -987,13 +1042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1061,13 +1121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1146,13 +1211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1244,13 +1314,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] }, @@ -1316,13 +1391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createIdentityProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" } ] } @@ -1383,13 +1463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" } ] }, @@ -1454,13 +1539,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ] }, @@ -1533,13 +1623,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ] } @@ -1600,13 +1695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api revokeJwksFromIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" } ] } @@ -1660,13 +1760,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1726,13 +1831,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1812,13 +1922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1886,13 +2001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1946,13 +2066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -2004,13 +2129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -2079,13 +2209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -2155,13 +2290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2225,13 +2365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2313,13 +2458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2388,13 +2538,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2464,13 +2619,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2541,13 +2701,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2607,13 +2772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2676,13 +2846,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2746,13 +2921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2817,13 +2997,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2899,13 +3084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2984,13 +3174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -3066,13 +3261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -3148,13 +3348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3220,13 +3425,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3304,13 +3514,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ] } @@ -3385,13 +3600,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3455,13 +3675,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3521,13 +3746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3597,13 +3827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3687,13 +3922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3768,13 +4008,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3825,13 +4070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3894,13 +4144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3951,13 +4206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -4017,13 +4277,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -4083,13 +4348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ] }, @@ -4210,13 +4480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ] } @@ -4283,13 +4558,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4385,13 +4665,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ] } @@ -4445,13 +4730,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ] }, @@ -4527,13 +4817,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ] } @@ -4584,13 +4879,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4654,13 +4954,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4735,13 +5040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4804,13 +5114,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4892,13 +5207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4968,13 +5288,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -5048,13 +5373,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5134,13 +5464,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -5214,13 +5549,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5294,13 +5634,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5377,13 +5722,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5451,13 +5801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -5540,13 +5895,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -5619,13 +5979,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5703,13 +6068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5778,13 +6148,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5856,13 +6231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5943,13 +6323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -6027,13 +6412,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -6106,13 +6496,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -6176,13 +6571,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ], "x-sunset": "2025-08-05" @@ -6245,13 +6645,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ], "x-sunset": "2025-08-05" @@ -6328,13 +6733,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ], "x-sunset": "2025-08-05" @@ -6410,13 +6820,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6491,13 +6906,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6572,13 +6992,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6654,13 +7079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6726,13 +7156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6810,13 +7245,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6892,13 +7332,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6985,13 +7430,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -7077,13 +7527,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -7166,13 +7621,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -7238,13 +7698,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7322,13 +7787,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7394,13 +7864,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7478,13 +7953,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7557,13 +8037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7645,13 +8130,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7717,13 +8207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPinnedNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" } ] }, @@ -7809,13 +8304,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPatch --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] }, @@ -7901,13 +8401,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPut --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] } @@ -7984,13 +8489,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" } ] } @@ -8075,13 +8585,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8171,13 +8686,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8261,13 +8781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -8346,13 +8871,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8448,13 +8978,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8523,13 +9058,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -8598,13 +9138,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ], "x-sunset": "2026-03-01" @@ -8685,13 +9230,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -8779,13 +9329,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ], "x-sunset": "2026-03-01" @@ -8869,13 +9424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -9045,13 +9605,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -9127,13 +9692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -9218,13 +9788,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -9327,13 +9902,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -9415,13 +9995,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -9504,13 +10089,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -9607,13 +10197,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9686,13 +10281,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9763,13 +10363,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9848,13 +10453,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9925,13 +10535,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ], "x-sunset": "2026-03-01" @@ -10016,13 +10631,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ], "x-sunset": "2026-03-01" @@ -10083,13 +10703,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -10176,13 +10801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -10258,13 +10888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -10343,13 +10978,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -10418,13 +11058,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ] }, @@ -10488,13 +11133,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ] }, @@ -10572,13 +11222,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] }, @@ -10656,13 +11311,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] } @@ -10745,13 +11405,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" } ] }, @@ -10833,13 +11498,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" } ] } @@ -10940,13 +11610,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" } ] } @@ -11043,13 +11718,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" } ] }, @@ -11144,13 +11824,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" } ] }, @@ -11259,13 +11944,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" } ] } @@ -11347,13 +12037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" } ] }, @@ -11443,13 +12138,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndex --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndex --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" } ] }, @@ -11543,13 +12243,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndex --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndex --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" } ] } @@ -11613,13 +12318,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -11692,13 +12402,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -11785,13 +12500,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -11870,13 +12590,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -11950,13 +12675,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -12041,13 +12771,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -12110,13 +12845,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -12199,13 +12939,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" } ] } @@ -12341,13 +13086,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -12430,13 +13180,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12511,13 +13266,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12628,13 +13388,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -12688,13 +13453,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" } ] } @@ -12772,13 +13542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -12850,13 +13625,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -12916,13 +13696,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -12995,13 +13780,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -13063,13 +13853,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -13154,13 +13949,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -13214,13 +14014,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -13292,13 +14097,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -13364,13 +14174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -13431,13 +14246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -13518,13 +14338,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -13591,13 +14416,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -13666,13 +14496,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -13732,13 +14567,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -13799,13 +14639,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -13886,13 +14731,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -13958,13 +14808,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -14036,13 +14891,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -14115,13 +14975,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -14208,13 +15073,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -14304,13 +15174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -14370,13 +15245,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -14600,13 +15480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -14682,13 +15567,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -14759,13 +15649,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -14856,13 +15751,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -14934,13 +15834,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -15026,13 +15931,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -15149,13 +16059,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -15269,13 +16184,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -15326,13 +16246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -15401,13 +16326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -15470,13 +16400,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -15548,13 +16483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -15640,13 +16580,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -15719,13 +16664,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -15852,13 +16802,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -15933,13 +16888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -15993,13 +16953,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -16099,13 +17064,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -16208,13 +17178,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -16309,13 +17284,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -16381,13 +17361,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -16466,13 +17451,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -16549,13 +17539,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -16655,13 +17650,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -16758,13 +17758,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -16828,13 +17833,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -16902,13 +17912,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -16970,13 +17985,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17038,13 +18058,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -17110,13 +18135,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -17193,13 +18223,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17254,13 +18289,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -17323,13 +18363,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -17410,13 +18455,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -17498,13 +18548,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -17597,13 +18652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -17675,13 +18735,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ] } @@ -17753,13 +18818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ] } @@ -17829,13 +18899,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -17895,13 +18970,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -17961,13 +19041,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -18015,13 +19100,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -18070,13 +19160,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -18136,13 +19231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -18190,13 +19290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -18244,13 +19349,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -18301,13 +19411,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -18358,13 +19473,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -18415,13 +19535,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -18533,13 +19658,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -18616,13 +19746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -18695,13 +19830,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -18767,13 +19907,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -18837,13 +19982,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -18924,13 +20074,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -18984,13 +20139,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -19053,13 +20213,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -19122,13 +20287,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -19192,13 +20362,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -19276,13 +20451,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -19351,13 +20531,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -19442,13 +20627,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -19514,13 +20704,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -19586,13 +20781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -19677,13 +20877,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -19762,13 +20967,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -19845,13 +21055,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -19928,13 +21143,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -20000,13 +21220,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -20060,13 +21285,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -20129,13 +21359,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -20200,13 +21435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -20281,13 +21521,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -20361,13 +21606,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -20439,13 +21689,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -20528,13 +21783,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -20603,13 +21863,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -20687,13 +21952,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -20772,13 +22042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -20876,13 +22151,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -20970,13 +22250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -21065,13 +22350,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -21127,13 +22417,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -21201,13 +22496,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -21273,13 +22573,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -21342,13 +22647,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -21414,13 +22724,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -21487,13 +22802,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -21553,13 +22873,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -21621,13 +22946,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -21687,13 +23017,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" } ] } @@ -21764,13 +23099,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -21841,13 +23181,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -21957,13 +23302,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -22034,13 +23384,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -22108,13 +23463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -22233,13 +23593,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -22465,13 +23830,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -22551,13 +23921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -22661,13 +24036,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -22787,13 +24167,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -22904,13 +24289,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -22967,13 +24357,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -23028,13 +24423,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -23101,13 +24501,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -23174,13 +24579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -23246,13 +24656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -23312,13 +24727,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -23378,13 +24798,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -23450,13 +24875,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -23531,13 +24961,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -23618,13 +25053,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -23702,13 +25142,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -23783,13 +25228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -23865,13 +25315,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -23934,13 +25389,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -24007,13 +25467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -24082,13 +25547,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -24155,13 +25625,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -24236,13 +25711,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -24302,13 +25782,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" } ] }, @@ -24372,13 +25857,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -24442,13 +25932,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -24509,13 +26004,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -24590,13 +26090,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] }, @@ -24673,13 +26178,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -24736,13 +26246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -24808,13 +26323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -24871,13 +26391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -24940,13 +26465,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -25012,13 +26542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -25087,13 +26622,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -25171,13 +26711,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -25270,13 +26815,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -25345,13 +26895,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -25426,13 +26981,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -25507,13 +27067,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -25580,13 +27145,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -25673,13 +27243,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -25756,13 +27331,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamProcessor --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamProcessor --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" } ] } @@ -25834,13 +27414,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamProcessor --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamProcessor --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" } ] }, @@ -25913,13 +27498,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" } ] } @@ -25994,13 +27584,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" } ] } @@ -26075,13 +27670,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api stopStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api stopStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" } ] } @@ -26156,13 +27756,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamProcessors --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamProcessors --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" } ] } @@ -26231,13 +27836,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -26313,13 +27923,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -26389,13 +28004,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -26480,13 +28100,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -26537,13 +28162,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -26606,13 +28236,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -26660,13 +28295,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -26717,13 +28357,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -26788,13 +28433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -26857,13 +28507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -26941,13 +28596,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -27013,13 +28673,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -27099,13 +28764,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -27164,13 +28834,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api migrateProjectToAnotherOrg --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api migrateProjectToAnotherOrg --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" } ] } @@ -27244,13 +28919,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -27319,13 +28999,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -27385,13 +29070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -27449,13 +29139,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -27524,13 +29219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -27594,13 +29294,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -27664,13 +29369,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -27737,13 +29447,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -27808,13 +29523,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -27893,13 +29613,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -27975,13 +29700,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -28071,13 +29801,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -28161,13 +29896,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -28246,13 +29986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -28314,13 +30059,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -28395,13 +30145,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -28500,13 +30255,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -28581,13 +30341,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -28644,13 +30409,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -28724,13 +30494,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -28799,13 +30574,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -28871,13 +30651,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -28943,13 +30728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -29015,13 +30805,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -29085,13 +30880,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -29169,13 +30969,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -29317,13 +31122,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -29377,13 +31187,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -29455,13 +31270,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -29526,13 +31346,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -29589,13 +31414,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -29646,13 +31476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -29715,13 +31550,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -29781,13 +31621,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" } ] }, @@ -29850,13 +31695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -29916,13 +31766,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -29983,13 +31838,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -30064,13 +31924,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -30139,13 +32004,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccountProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" } ] } @@ -30219,13 +32089,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" } ] } @@ -30294,13 +32169,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" } ] } @@ -30357,13 +32237,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -30429,13 +32314,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -30505,13 +32395,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -30584,13 +32479,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -30660,13 +32560,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -30739,13 +32644,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -30816,13 +32726,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -30907,13 +32822,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -30995,13 +32915,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -31089,13 +33014,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -31177,13 +33107,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -31249,13 +33184,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -31324,13 +33264,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -31410,13 +33355,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -31453,13 +33403,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllControlPlaneIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" } ] } @@ -31521,13 +33476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-05-30+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -31588,13 +33548,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -31657,13 +33622,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml index 5faf7a3ad3..c398e3df95 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml @@ -29866,16 +29866,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -29903,16 +29909,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -29941,16 +29953,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -29979,16 +29997,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -30015,16 +30039,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -30056,16 +30086,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -30105,16 +30141,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -30153,16 +30195,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -30208,18 +30256,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30250,16 +30306,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -30296,18 +30358,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30346,16 +30416,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -30395,16 +30471,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -30451,18 +30533,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30516,16 +30606,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30566,18 +30662,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/)." @@ -30612,16 +30716,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' operationId: getIdentityProvider @@ -30659,16 +30769,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30714,18 +30830,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks)." @@ -30760,16 +30884,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api revokeJwksFromIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30799,16 +30929,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -30839,16 +30975,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -30896,18 +31038,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -30936,16 +31086,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -30973,16 +31129,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -31021,18 +31183,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -31071,18 +31241,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31115,16 +31293,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -31169,18 +31353,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31225,16 +31417,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -31275,16 +31473,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -31325,16 +31529,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -31367,16 +31577,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31414,18 +31630,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -31465,16 +31689,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31515,16 +31745,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31574,18 +31810,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31637,18 +31881,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -31693,16 +31945,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -31746,16 +32004,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -31796,16 +32060,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: description: |- Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31854,18 +32124,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -31909,16 +32187,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -31951,16 +32235,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -31993,18 +32283,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32045,16 +32343,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -32101,18 +32405,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -32156,18 +32468,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -32194,16 +32514,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -32238,18 +32564,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32276,16 +32610,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -32318,18 +32658,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: 'Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -32359,16 +32707,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" post: description: 'Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: createExportBucket @@ -32444,18 +32798,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. @@ -32495,16 +32857,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: description: 'Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getExportBucket @@ -32564,16 +32932,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -32602,16 +32976,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateDataProtectionSettings @@ -32655,18 +33035,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32693,16 +33081,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -32738,18 +33132,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -32793,16 +33195,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32838,16 +33246,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -32896,18 +33310,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: deprecated: true @@ -32944,16 +33366,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" x-sunset: "2026-03-01" post: deprecated: true @@ -32996,18 +33424,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: @@ -33053,16 +33489,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: deprecated: true description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -33102,16 +33544,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -33161,18 +33609,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: @@ -33263,16 +33719,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. @@ -33320,16 +33782,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33368,16 +33836,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -33424,18 +33898,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33476,16 +33958,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getBackupExportJob --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33524,16 +34012,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -33584,18 +34078,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33642,16 +34144,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -33695,16 +34203,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: deprecated: true @@ -33742,16 +34256,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" x-sunset: "2025-08-05" get: deprecated: true @@ -33788,16 +34308,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" x-sunset: "2025-08-05" patch: deprecated: true @@ -33846,18 +34372,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' x-sunset: "2025-08-05" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: @@ -33899,16 +34433,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -33955,18 +34495,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -34013,16 +34561,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -34068,16 +34622,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -34130,18 +34690,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34186,16 +34754,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -34241,16 +34815,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34288,16 +34868,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -34348,18 +34934,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -34408,18 +35002,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34457,16 +35059,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34513,16 +35121,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34560,16 +35174,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34616,16 +35236,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -34665,16 +35291,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -34724,16 +35356,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. @@ -34772,16 +35410,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPinnedNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster operationId: pinNamespacesPatch @@ -34833,18 +35477,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api pinNamespacesPatch --help 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. operationId: pinNamespacesPut @@ -34896,18 +35548,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPut --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster @@ -34953,18 +35613,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -35015,18 +35683,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -35081,16 +35757,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -35142,16 +35824,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -35200,16 +35888,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -35269,18 +35963,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -35321,16 +36023,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: @@ -35371,16 +36079,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" x-sunset: "2026-03-01" post: deprecated: true @@ -35429,18 +36143,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: @@ -35493,16 +36215,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" x-sunset: "2026-03-01" post: deprecated: true @@ -35553,18 +36281,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: @@ -35676,18 +36412,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35729,16 +36473,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -35789,18 +36539,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -35850,16 +36608,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -35910,16 +36674,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -35979,18 +36749,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -36056,16 +36834,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -36108,16 +36892,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -36159,16 +36949,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -36215,18 +37011,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: deprecated: true @@ -36268,16 +37072,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" x-sunset: "2026-03-01" patch: deprecated: true @@ -36329,18 +37139,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' x-sunset: "2026-03-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: @@ -36375,18 +37193,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -36439,16 +37265,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -36493,18 +37325,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -36555,16 +37395,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: description: Deletes the Search Nodes for the specified cluster. @@ -36604,16 +37450,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" get: description: 'Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: getAtlasSearchDeployment @@ -36650,16 +37502,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" patch: description: 'Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: updateAtlasSearchDeployment @@ -36705,18 +37563,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' post: description: Creates Search Nodes for the specified cluster. operationId: createAtlasSearchDeployment @@ -36762,18 +37628,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: description: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -36822,16 +37696,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -36880,18 +37760,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: description: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -36952,16 +37840,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: description: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -37020,16 +37914,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -37087,16 +37987,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37163,18 +38069,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -37224,16 +38138,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -37288,16 +38208,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37355,18 +38281,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: deprecated: true @@ -37406,16 +38340,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -37461,18 +38401,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -37522,16 +38470,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -37579,16 +38533,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -37633,16 +38593,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -37694,18 +38660,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37741,16 +38715,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -37799,18 +38779,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api pinFeatureCompatibilityVersion --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release. @@ -37854,18 +38842,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinFeatureCompatibilityVersion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -37936,16 +38932,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -37987,16 +38989,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -38038,18 +39046,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -38091,18 +39107,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. @@ -38132,16 +39156,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -38184,16 +39214,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -38234,18 +39270,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -38288,16 +39332,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -38333,16 +39383,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -38393,18 +39449,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38434,16 +39498,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38472,16 +39542,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -38522,18 +39598,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -38570,16 +39654,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -38613,16 +39703,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -38669,18 +39765,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -38718,16 +39822,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -38766,18 +39876,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -38810,16 +39928,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -38854,16 +39978,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -38910,18 +40040,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38958,16 +40096,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -39018,16 +40162,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -39078,16 +40228,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -39148,18 +40304,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -39216,16 +40380,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39255,16 +40425,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -39396,18 +40572,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39464,16 +40648,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -39527,16 +40717,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -39603,18 +40799,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39652,16 +40856,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39717,18 +40927,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -39801,16 +41019,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -39880,16 +41104,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -39919,16 +41149,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -39979,18 +41215,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -40025,16 +41269,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -40075,18 +41325,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -40137,16 +41395,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -40189,16 +41453,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -40282,16 +41552,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -40338,16 +41614,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40376,16 +41658,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40444,16 +41732,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -40511,16 +41805,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40577,16 +41877,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -40620,16 +41926,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -40678,16 +41990,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -40735,16 +42053,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -40804,18 +42128,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -40873,18 +42205,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -40920,16 +42260,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -40968,18 +42314,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -41014,18 +42368,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -41062,16 +42424,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -41110,16 +42478,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -41166,18 +42540,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -41207,16 +42589,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41251,16 +42639,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -41327,16 +42721,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -41404,16 +42804,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -41491,18 +42897,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: description: |- @@ -41550,18 +42964,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. @@ -41593,16 +43015,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -41634,18 +43062,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: 'Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. Deprecated versions: v2-{2023-01-01}' @@ -41686,18 +43122,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. @@ -41739,16 +43183,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -41774,16 +43224,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -41809,16 +43265,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -41852,18 +43314,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -41889,18 +43359,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -41926,18 +43404,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api deferMaintenanceWindow --help /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -41964,16 +43450,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42000,16 +43492,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42036,18 +43534,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -42115,16 +43621,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42166,16 +43678,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -42217,18 +43735,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -42266,16 +43792,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -42312,16 +43844,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -42369,18 +43907,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42410,16 +43956,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -42455,18 +44007,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -42503,16 +44063,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -42549,16 +44115,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -42605,18 +44177,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42656,16 +44236,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42713,16 +44299,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42760,18 +44352,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42809,18 +44409,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42868,16 +44476,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -42925,16 +44539,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -42981,16 +44601,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -43035,18 +44661,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43086,16 +44720,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43142,16 +44782,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -43199,16 +44845,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getPrivateEndpointService --help /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -43268,18 +44920,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -43333,16 +44993,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -43397,16 +45063,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -43443,18 +45115,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43483,16 +45163,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -43527,18 +45213,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -43576,16 +45270,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -43633,18 +45333,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -43689,16 +45397,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -43742,16 +45456,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -43802,18 +45522,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -43844,16 +45572,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43892,18 +45626,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -43937,16 +45679,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -44000,18 +45748,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44049,16 +45805,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -44097,16 +45859,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44136,16 +45904,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44180,16 +45954,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace @@ -44259,16 +46039,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. @@ -44298,16 +46084,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForHost --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44345,16 +46137,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44395,16 +46193,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44471,16 +46275,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44518,16 +46328,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44567,16 +46383,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -44659,16 +46481,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -44862,16 +46690,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44926,16 +46760,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -45007,16 +46847,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45095,16 +46941,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -45135,16 +46987,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -45174,16 +47032,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -45221,18 +47085,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -45270,18 +47142,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -45320,18 +47200,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -45366,16 +47254,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45405,16 +47299,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -45451,18 +47351,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45503,16 +47411,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -45560,18 +47474,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45618,16 +47540,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45668,16 +47596,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45724,16 +47658,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -45769,16 +47709,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -45818,18 +47764,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -45869,16 +47823,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -45917,16 +47877,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -45970,18 +47936,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns list of Service Accounts for a project with service account details. @@ -46012,16 +47986,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" post: description: Creates and assigns the specified Service Account to the specified Project. operationId: createProjectServiceAccount @@ -46057,18 +48037,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: delete: description: Removes one Service Account from the specified project. @@ -46104,16 +48092,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" get: description: Get project Service Account Details. operationId: getProjectServiceAccount @@ -46147,16 +48141,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account in Project. operationId: updateProjectServiceAccount @@ -46199,18 +48199,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' post: description: Assigns the specified organization Service Account to the specified project. operationId: addProjectServiceAccount @@ -46255,18 +48263,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46297,16 +48313,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -46343,18 +48365,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -46383,16 +48413,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -46427,18 +48463,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -46475,16 +48519,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -46524,16 +48574,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -46578,18 +48634,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -46647,16 +48711,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -46693,16 +48763,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -46745,18 +48821,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -46799,16 +48883,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -46847,16 +48937,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -46907,18 +49003,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor: post: description: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -46962,18 +49066,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: description: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47014,16 +49126,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: getStreamProcessor @@ -47065,16 +49183,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47117,18 +49241,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: description: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47171,18 +49303,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api stopStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api stopStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: description: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47222,16 +49362,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamProcessors --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listStreamProcessors --help /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -47267,16 +49413,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -47320,18 +49472,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -47373,16 +49533,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -47433,18 +49599,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47471,16 +49645,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47518,18 +49698,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -47558,16 +49746,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47594,16 +49788,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47639,18 +49839,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47686,16 +49894,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -47737,16 +49951,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47784,16 +50004,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -47840,18 +50066,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}:migrate: post: description: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. @@ -47884,18 +50118,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api migrateProjectToAnotherOrg --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api migrateProjectToAnotherOrg --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -47935,16 +50177,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -47984,16 +50232,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -48033,18 +50287,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -48083,16 +50345,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -48124,16 +50392,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -48172,18 +50446,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -48216,16 +50498,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -48261,18 +50549,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48311,16 +50607,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -48358,16 +50660,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -48414,18 +50722,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api updateApiKey --help /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -48467,16 +50783,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -48527,18 +50849,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -48589,16 +50919,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -48646,16 +50982,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -48690,18 +51032,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -48746,16 +51096,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -48817,16 +51173,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -48873,16 +51235,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -48913,16 +51281,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -48969,16 +51343,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49017,16 +51397,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -49063,18 +51449,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -49111,18 +51505,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49159,16 +51561,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -49206,16 +51614,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -49261,18 +51675,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -49363,16 +51785,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -49416,16 +51844,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -49470,16 +51904,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -49508,16 +51948,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -49548,16 +51994,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -49585,16 +52037,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -49629,18 +52087,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns list of Service Accounts with service account details. @@ -49671,16 +52137,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" post: description: Create Service Account containing client id and client secrets. operationId: createServiceAccount @@ -49715,18 +52187,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: delete: description: Delete Service Account. @@ -49759,16 +52239,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" get: description: Get Service Account Details. operationId: getServiceAccount @@ -49802,16 +52288,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account. operationId: updateServiceAccount @@ -49854,18 +52346,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: get: description: Returns list of Service Account projects. @@ -49902,16 +52402,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccountProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: post: description: Create Service Account secret. @@ -49953,18 +52459,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: delete: description: Delete Service Account Secret. @@ -50003,16 +52517,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50043,16 +52563,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -50089,18 +52615,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -50137,16 +52671,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -50188,18 +52728,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50242,16 +52790,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -50293,16 +52847,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -50353,18 +52913,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -50411,16 +52979,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -50473,18 +53047,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50534,16 +53116,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -50583,16 +53171,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -50626,16 +53220,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -50676,16 +53276,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -50732,18 +53338,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access). @@ -50764,16 +53378,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllControlPlaneIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" /api/atlas/v2/users: post: description: |- @@ -50813,18 +53433,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ - --header "Content-Type: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -50861,16 +53489,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -50905,16 +53539,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-05-30+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-05-30+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json index 8a2484c434..0ad5790cc2 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json @@ -250,13 +250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -307,13 +312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -370,13 +380,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -433,13 +448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -487,13 +507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -553,13 +578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -626,13 +656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -697,13 +732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -779,13 +819,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -842,13 +887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -914,13 +964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -987,13 +1042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1061,13 +1121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1146,13 +1211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1244,13 +1314,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] }, @@ -1316,13 +1391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createIdentityProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" } ] } @@ -1383,13 +1463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" } ] }, @@ -1454,13 +1539,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ] }, @@ -1533,13 +1623,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ] } @@ -1600,13 +1695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api revokeJwksFromIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" } ] } @@ -1660,13 +1760,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1726,13 +1831,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1812,13 +1922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1886,13 +2001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1946,13 +2066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -2004,13 +2129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -2079,13 +2209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -2155,13 +2290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2225,13 +2365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2313,13 +2458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2388,13 +2538,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2464,13 +2619,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2541,13 +2701,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2607,13 +2772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2676,13 +2846,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2746,13 +2921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2817,13 +2997,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2899,13 +3084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2984,13 +3174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -3066,13 +3261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -3148,13 +3348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3220,13 +3425,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3304,13 +3514,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ] } @@ -3385,13 +3600,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3455,13 +3675,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3521,13 +3746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3597,13 +3827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3687,13 +3922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3768,13 +4008,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3825,13 +4070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3894,13 +4144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3951,13 +4206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -4017,13 +4277,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -4083,13 +4348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ] }, @@ -4210,13 +4480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ] } @@ -4283,13 +4558,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4385,13 +4665,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ] } @@ -4445,13 +4730,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ] }, @@ -4527,13 +4817,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ] } @@ -4584,13 +4879,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4654,13 +4954,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4735,13 +5040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4804,13 +5114,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4892,13 +5207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4967,13 +5287,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ] }, @@ -5052,13 +5377,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ] } @@ -5137,13 +5467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -5217,13 +5552,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5297,13 +5637,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5380,13 +5725,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5453,13 +5803,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ] }, @@ -5541,13 +5896,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ] } @@ -5619,13 +5979,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5703,13 +6068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5778,13 +6148,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5856,13 +6231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5943,13 +6323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -6027,13 +6412,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -6106,13 +6496,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -6175,13 +6570,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ] }, @@ -6242,13 +6642,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ] }, @@ -6323,13 +6728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ] } @@ -6404,13 +6814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6485,13 +6900,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6566,13 +6986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6648,13 +7073,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6720,13 +7150,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6804,13 +7239,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6886,13 +7326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6979,13 +7424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -7071,13 +7521,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -7160,13 +7615,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -7232,13 +7692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7316,13 +7781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7388,13 +7858,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7472,13 +7947,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7551,13 +8031,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7639,13 +8124,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7711,13 +8201,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPinnedNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" } ] }, @@ -7803,13 +8298,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPatch --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] }, @@ -7895,13 +8395,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPut --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] } @@ -7978,13 +8483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" } ] } @@ -8069,13 +8579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8165,13 +8680,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8255,13 +8775,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -8340,13 +8865,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8442,13 +8972,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8516,13 +9051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ] } @@ -8589,13 +9129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ] }, @@ -8675,13 +9220,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ] } @@ -8767,13 +9317,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ] }, @@ -8856,13 +9411,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ] } @@ -9031,13 +9591,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -9113,13 +9678,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -9204,13 +9774,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -9313,13 +9888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -9401,13 +9981,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -9490,13 +10075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -9593,13 +10183,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9672,13 +10267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9749,13 +10349,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9834,13 +10439,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9910,13 +10520,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ] }, @@ -9999,13 +10614,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ] } @@ -10065,13 +10685,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -10158,13 +10783,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -10240,13 +10870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -10325,13 +10960,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -10400,13 +11040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ] }, @@ -10470,13 +11115,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ] }, @@ -10554,13 +11204,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] }, @@ -10638,13 +11293,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] } @@ -10727,13 +11387,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" } ] }, @@ -10815,13 +11480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" } ] } @@ -10922,13 +11592,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" } ] } @@ -11025,13 +11700,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" } ] }, @@ -11126,13 +11806,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" } ] }, @@ -11241,13 +11926,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" } ] } @@ -11329,13 +12019,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" } ] }, @@ -11425,13 +12120,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndex --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndex --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" } ] }, @@ -11525,13 +12225,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndex --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndex --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" } ] } @@ -11595,13 +12300,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -11674,13 +12384,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -11767,13 +12482,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -11852,13 +12572,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -11932,13 +12657,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -12023,13 +12753,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -12092,13 +12827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -12181,13 +12921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" } ] } @@ -12323,13 +13068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -12412,13 +13162,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12493,13 +13248,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12610,13 +13370,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -12670,13 +13435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" } ] } @@ -12754,13 +13524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -12832,13 +13607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -12898,13 +13678,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -12977,13 +13762,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -13045,13 +13835,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -13136,13 +13931,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -13196,13 +13996,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -13274,13 +14079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -13346,13 +14156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -13413,13 +14228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -13500,13 +14320,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -13573,13 +14398,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -13648,13 +14478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -13714,13 +14549,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -13781,13 +14621,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -13868,13 +14713,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -13940,13 +14790,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -14018,13 +14873,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -14097,13 +14957,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -14190,13 +15055,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -14286,13 +15156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -14352,13 +15227,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -14582,13 +15462,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -14664,13 +15549,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -14741,13 +15631,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -14838,13 +15733,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -14916,13 +15816,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -15008,13 +15913,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -15131,13 +16041,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -15251,13 +16166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -15308,13 +16228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -15383,13 +16308,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -15452,13 +16382,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -15530,13 +16465,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -15622,13 +16562,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -15701,13 +16646,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -15834,13 +16784,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -15915,13 +16870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -15975,13 +16935,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -16081,13 +17046,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -16190,13 +17160,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIndexMetrics --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -16291,13 +17266,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -16363,13 +17343,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -16448,13 +17433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -16531,13 +17521,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -16637,13 +17632,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -16740,13 +17740,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -16810,13 +17815,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -16884,13 +17894,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -16952,13 +17967,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17020,13 +18040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -17092,13 +18117,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -17175,13 +18205,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17236,13 +18271,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -17305,13 +18345,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -17392,13 +18437,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -17480,13 +18530,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -17579,13 +18634,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -17657,13 +18717,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ] } @@ -17735,13 +18800,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ] } @@ -17811,13 +18881,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -17877,13 +18952,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -17943,13 +19023,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -17997,13 +19082,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -18052,13 +19142,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -18118,13 +19213,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -18172,13 +19272,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -18226,13 +19331,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -18283,13 +19393,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -18340,13 +19455,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -18397,13 +19517,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -18515,13 +19640,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -18598,13 +19728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -18677,13 +19812,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -18749,13 +19889,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -18819,13 +19964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -18906,13 +20056,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -18966,13 +20121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -19035,13 +20195,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -19104,13 +20269,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -19174,13 +20344,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -19258,13 +20433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -19333,13 +20513,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -19424,13 +20609,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -19496,13 +20686,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -19568,13 +20763,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -19659,13 +20859,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -19744,13 +20949,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -19827,13 +21037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -19910,13 +21125,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -19982,13 +21202,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -20042,13 +21267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -20111,13 +21341,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -20182,13 +21417,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -20263,13 +21503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -20343,13 +21588,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -20421,13 +21671,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -20510,13 +21765,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -20585,13 +21845,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -20669,13 +21934,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -20754,13 +22024,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -20858,13 +22133,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -20952,13 +22232,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -21047,13 +22332,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -21109,13 +22399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -21183,13 +22478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -21255,13 +22555,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -21324,13 +22629,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -21396,13 +22706,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -21469,13 +22784,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -21535,13 +22855,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -21603,13 +22928,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -21669,13 +22999,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" } ] } @@ -21746,13 +23081,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -21823,13 +23163,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -21939,13 +23284,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -22016,13 +23366,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -22090,13 +23445,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -22215,13 +23575,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -22447,13 +23812,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -22533,13 +23903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -22643,13 +24018,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -22769,13 +24149,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -22886,13 +24271,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -22949,13 +24339,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -23010,13 +24405,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -23083,13 +24483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -23156,13 +24561,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -23228,13 +24638,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -23294,13 +24709,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -23360,13 +24780,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -23432,13 +24857,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -23513,13 +24943,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -23600,13 +25035,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -23684,13 +25124,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -23765,13 +25210,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -23847,13 +25297,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -23916,13 +25371,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -23989,13 +25449,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -24064,13 +25529,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -24137,13 +25607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -24218,13 +25693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -24284,13 +25764,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" } ] }, @@ -24354,13 +25839,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -24424,13 +25914,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -24491,13 +25986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -24572,13 +26072,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] }, @@ -24655,13 +26160,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -24718,13 +26228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -24790,13 +26305,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -24853,13 +26373,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -24922,13 +26447,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -24994,13 +26524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -25069,13 +26604,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -25153,13 +26693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -25252,13 +26797,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -25327,13 +26877,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -25408,13 +26963,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -25489,13 +27049,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -25562,13 +27127,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -25655,13 +27225,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -25738,13 +27313,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamProcessor --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamProcessor --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" } ] } @@ -25816,13 +27396,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamProcessor --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamProcessor --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" } ] }, @@ -25895,13 +27480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" } ] } @@ -25976,13 +27566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" } ] } @@ -26057,13 +27652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api stopStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api stopStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" } ] } @@ -26138,13 +27738,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamProcessors --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamProcessors --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" } ] } @@ -26213,13 +27818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -26295,13 +27905,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -26371,13 +27986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -26462,13 +28082,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -26519,13 +28144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -26588,13 +28218,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -26642,13 +28277,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -26699,13 +28339,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -26770,13 +28415,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -26839,13 +28489,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -26923,13 +28578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -26995,13 +28655,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -27081,13 +28746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -27146,13 +28816,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api migrateProjectToAnotherOrg --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api migrateProjectToAnotherOrg --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" } ] } @@ -27226,13 +28901,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -27301,13 +28981,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -27367,13 +29052,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -27431,13 +29121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -27506,13 +29201,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -27576,13 +29276,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -27646,13 +29351,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -27719,13 +29429,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -27790,13 +29505,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -27875,13 +29595,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -27957,13 +29682,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -28053,13 +29783,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -28143,13 +29878,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -28228,13 +29968,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -28296,13 +30041,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -28377,13 +30127,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -28482,13 +30237,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -28563,13 +30323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -28626,13 +30391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -28706,13 +30476,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -28781,13 +30556,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -28853,13 +30633,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -28925,13 +30710,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -28997,13 +30787,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -29067,13 +30862,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -29151,13 +30951,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -29299,13 +31104,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -29359,13 +31169,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -29437,13 +31252,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -29508,13 +31328,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -29571,13 +31396,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -29628,13 +31458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -29697,13 +31532,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -29763,13 +31603,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" } ] }, @@ -29832,13 +31677,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -29898,13 +31748,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -29965,13 +31820,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -30046,13 +31906,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -30121,13 +31986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccountProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" } ] } @@ -30201,13 +32071,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" } ] } @@ -30276,13 +32151,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" } ] } @@ -30339,13 +32219,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -30411,13 +32296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -30487,13 +32377,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -30566,13 +32461,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -30642,13 +32542,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -30721,13 +32626,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -30798,13 +32708,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -30889,13 +32804,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -30977,13 +32897,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -31071,13 +32996,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -31159,13 +33089,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -31231,13 +33166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -31306,13 +33246,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -31392,13 +33337,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -31435,13 +33385,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllControlPlaneIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" } ] } @@ -31503,13 +33458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/vnd.atlas.2024-08-05+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -31570,13 +33530,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -31639,13 +33604,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml index 2f66568bbd..fb0607b701 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml @@ -30144,16 +30144,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -30181,16 +30187,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -30219,16 +30231,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -30257,16 +30275,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -30293,16 +30317,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -30334,16 +30364,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -30383,16 +30419,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -30431,16 +30473,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -30486,18 +30534,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30528,16 +30584,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -30574,18 +30636,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30624,16 +30694,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -30673,16 +30749,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -30729,18 +30811,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30794,16 +30884,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30844,18 +30940,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/)." @@ -30890,16 +30994,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' operationId: getIdentityProvider @@ -30937,16 +31047,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -30992,18 +31108,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks)." @@ -31038,16 +31162,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api revokeJwksFromIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -31077,16 +31207,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -31117,16 +31253,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -31174,18 +31316,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31214,16 +31364,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -31251,16 +31407,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -31299,18 +31461,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -31349,18 +31519,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31393,16 +31571,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -31447,18 +31631,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31503,16 +31695,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -31553,16 +31751,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -31603,16 +31807,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -31645,16 +31855,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31692,18 +31908,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -31743,16 +31967,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -31793,16 +32023,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31852,18 +32088,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -31915,18 +32159,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -31971,16 +32223,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -32024,16 +32282,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -32074,16 +32338,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: description: |- Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -32132,18 +32402,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -32187,16 +32465,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -32229,16 +32513,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -32271,18 +32561,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32323,16 +32621,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -32379,18 +32683,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -32434,18 +32746,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -32472,16 +32792,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -32516,18 +32842,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32554,16 +32888,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -32596,18 +32936,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: 'Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -32637,16 +32985,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" post: description: 'Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: createExportBucket @@ -32722,18 +33076,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. @@ -32773,16 +33135,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: description: 'Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getExportBucket @@ -32842,16 +33210,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -32880,16 +33254,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateDataProtectionSettings @@ -32933,18 +33313,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32971,16 +33359,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -33016,18 +33410,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -33071,16 +33473,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33116,16 +33524,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -33174,18 +33588,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: description: 'Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -33221,16 +33643,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" post: description: 'Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' operationId: createCluster @@ -33399,18 +33827,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: description: 'Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -33455,16 +33891,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' operationId: getCluster @@ -33503,16 +33945,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" 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 API Key must have the Project Owner role. For all other updates, the requesting 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-{2023-02-01}, v2-{2023-01-01}' operationId: updateCluster @@ -33561,18 +34009,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. @@ -33662,16 +34118,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. @@ -33719,16 +34181,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33767,16 +34235,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -33823,18 +34297,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -33875,16 +34357,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getBackupExportJob --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33923,16 +34411,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -33983,18 +34477,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34041,16 +34543,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -34094,16 +34602,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: description: 'Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. Deprecated versions: v2-{2023-01-01}' @@ -34140,16 +34654,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" 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 API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getBackupSchedule @@ -34184,16 +34704,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" 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 API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateBackupSchedule @@ -34240,18 +34766,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34292,16 +34826,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -34348,18 +34888,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -34406,16 +34954,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -34461,16 +35015,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -34523,18 +35083,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34579,16 +35147,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -34634,16 +35208,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34681,16 +35261,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -34741,18 +35327,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -34801,18 +35395,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34850,16 +35452,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34906,16 +35514,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34953,16 +35567,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35009,16 +35629,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -35058,16 +35684,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -35117,16 +35749,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. @@ -35165,16 +35803,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPinnedNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster operationId: pinNamespacesPatch @@ -35226,18 +35870,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api pinNamespacesPatch --help 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. operationId: pinNamespacesPut @@ -35289,18 +35941,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPut --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster @@ -35346,18 +36006,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -35408,18 +36076,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -35474,16 +36150,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -35535,16 +36217,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -35593,16 +36281,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -35662,18 +36356,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -35713,16 +36415,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: description: 'Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -35761,16 +36469,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" 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 API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: @@ -35818,18 +36532,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: description: 'Removes 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. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -35880,16 +36602,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" 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 API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: @@ -35939,18 +36667,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: description: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -36061,18 +36797,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36114,16 +36858,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -36174,18 +36924,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -36235,16 +36993,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -36295,16 +37059,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -36364,18 +37134,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -36441,16 +37219,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -36493,16 +37277,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -36544,16 +37334,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -36600,18 +37396,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: 'Returns 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. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -36652,16 +37456,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" 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 API Key must have the Project Cluster Manager role. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. Deprecated versions: v2-{2023-01-01}' externalDocs: @@ -36711,18 +37521,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: description: 'Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster''s primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. Deprecated versions: v2-{2023-01-01}' @@ -36756,18 +37574,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -36820,16 +37646,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -36874,18 +37706,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -36936,16 +37776,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: description: Deletes the Search Nodes for the specified cluster. @@ -36985,16 +37831,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" get: description: 'Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: getAtlasSearchDeployment @@ -37031,16 +37883,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" patch: description: 'Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: updateAtlasSearchDeployment @@ -37086,18 +37944,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' post: description: Creates Search Nodes for the specified cluster. operationId: createAtlasSearchDeployment @@ -37143,18 +38009,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: description: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -37203,16 +38077,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37261,18 +38141,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: description: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -37333,16 +38221,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: description: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -37401,16 +38295,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -37468,16 +38368,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37544,18 +38450,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -37605,16 +38519,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -37669,16 +38589,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37736,18 +38662,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: deprecated: true @@ -37787,16 +38721,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -37842,18 +38782,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -37903,16 +38851,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -37960,16 +38914,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -38014,16 +38974,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -38075,18 +39041,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38122,16 +39096,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -38180,18 +39160,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api pinFeatureCompatibilityVersion --help /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release. @@ -38235,18 +39223,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinFeatureCompatibilityVersion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -38317,16 +39313,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38368,16 +39370,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -38419,18 +39427,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -38472,18 +39488,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. @@ -38513,16 +39537,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -38565,16 +39595,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -38615,18 +39651,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -38669,16 +39713,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -38714,16 +39764,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -38774,18 +39830,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38815,16 +39879,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38853,16 +39923,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -38903,18 +39979,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -38951,16 +40035,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -38994,16 +40084,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -39050,18 +40146,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -39099,16 +40203,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -39147,18 +40257,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -39191,16 +40309,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -39235,16 +40359,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -39291,18 +40421,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39339,16 +40477,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -39399,16 +40543,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -39459,16 +40609,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -39529,18 +40685,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -39597,16 +40761,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39636,16 +40806,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -39777,18 +40953,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39845,16 +41029,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -39908,16 +41098,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -39984,18 +41180,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40033,16 +41237,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40098,18 +41308,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -40182,16 +41400,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -40261,16 +41485,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -40300,16 +41530,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -40360,18 +41596,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -40406,16 +41650,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -40456,18 +41706,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -40518,16 +41776,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -40570,16 +41834,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -40663,16 +41933,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -40719,16 +41995,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40757,16 +42039,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40825,16 +42113,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -40892,16 +42186,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -40958,16 +42258,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -41001,16 +42307,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -41059,16 +42371,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -41116,16 +42434,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -41185,18 +42509,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -41254,18 +42586,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -41301,16 +42641,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -41349,18 +42695,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -41395,18 +42749,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -41443,16 +42805,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -41491,16 +42859,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -41547,18 +42921,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -41588,16 +42970,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -41632,16 +43020,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -41708,16 +43102,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -41785,16 +43185,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -41872,18 +43278,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: description: |- @@ -41931,18 +43345,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. @@ -41974,16 +43396,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -42015,18 +43443,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: 'Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. Deprecated versions: v2-{2023-01-01}' @@ -42067,18 +43503,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. @@ -42120,16 +43564,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -42155,16 +43605,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -42190,16 +43646,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -42233,18 +43695,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42270,18 +43740,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -42307,18 +43785,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api deferMaintenanceWindow --help /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -42345,16 +43831,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42381,16 +43873,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42417,18 +43915,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -42496,16 +44002,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42547,16 +44059,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -42598,18 +44116,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -42647,16 +44173,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -42693,16 +44225,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -42750,18 +44288,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42791,16 +44337,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -42836,18 +44388,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -42884,16 +44444,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -42930,16 +44496,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -42986,18 +44558,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43037,16 +44617,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43094,16 +44680,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43141,18 +44733,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43190,18 +44790,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43249,16 +44857,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -43306,16 +44920,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -43362,16 +44982,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -43416,18 +45042,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43467,16 +45101,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43523,16 +45163,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -43580,16 +45226,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getPrivateEndpointService --help /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -43649,18 +45301,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -43714,16 +45374,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -43778,16 +45444,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -43824,18 +45496,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43864,16 +45544,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -43908,18 +45594,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -43957,16 +45651,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -44014,18 +45714,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -44070,16 +45778,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -44123,16 +45837,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -44183,18 +45903,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -44225,16 +45953,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44273,18 +46007,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -44318,16 +46060,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -44381,18 +46129,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44430,16 +46186,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -44478,16 +46240,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44517,16 +46285,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44561,16 +46335,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace @@ -44640,16 +46420,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. @@ -44679,16 +46465,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForHost --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44726,16 +46518,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44776,16 +46574,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44852,16 +46656,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44899,16 +46709,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44948,16 +46764,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -45040,16 +46862,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -45243,16 +47071,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45307,16 +47141,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -45388,16 +47228,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45476,16 +47322,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSuggestedIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -45516,16 +47368,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -45555,16 +47413,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -45602,18 +47466,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -45651,18 +47523,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -45701,18 +47581,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -45747,16 +47635,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45786,16 +47680,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -45832,18 +47732,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45884,16 +47792,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -45941,18 +47855,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -45999,16 +47921,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46049,16 +47977,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46105,16 +48039,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -46150,16 +48090,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -46199,18 +48145,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -46250,16 +48204,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -46298,16 +48258,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -46351,18 +48317,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns list of Service Accounts for a project with service account details. @@ -46393,16 +48367,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" post: description: Creates and assigns the specified Service Account to the specified Project. operationId: createProjectServiceAccount @@ -46438,18 +48418,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: delete: description: Removes one Service Account from the specified project. @@ -46485,16 +48473,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" get: description: Get project Service Account Details. operationId: getProjectServiceAccount @@ -46528,16 +48522,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account in Project. operationId: updateProjectServiceAccount @@ -46580,18 +48580,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' post: description: Assigns the specified organization Service Account to the specified project. operationId: addProjectServiceAccount @@ -46636,18 +48644,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46678,16 +48694,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -46724,18 +48746,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -46764,16 +48794,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -46808,18 +48844,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -46856,16 +48900,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -46905,16 +48955,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -46959,18 +49015,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -47028,16 +49092,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -47074,16 +49144,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -47126,18 +49202,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47180,16 +49264,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -47228,16 +49318,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -47288,18 +49384,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor: post: description: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47343,18 +49447,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: description: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47395,16 +49507,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: getStreamProcessor @@ -47446,16 +49564,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47498,18 +49622,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: description: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47552,18 +49684,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api stopStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api stopStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: description: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47603,16 +49743,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamProcessors --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listStreamProcessors --help /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -47648,16 +49794,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -47701,18 +49853,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -47754,16 +49914,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -47814,18 +49980,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47852,16 +50026,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47899,18 +50079,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api saveLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -47939,16 +50127,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -47975,16 +50169,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48020,18 +50220,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48067,16 +50275,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -48118,16 +50332,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48165,16 +50385,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -48221,18 +50447,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}:migrate: post: description: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48265,18 +50499,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api migrateProjectToAnotherOrg --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api migrateProjectToAnotherOrg --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -48316,16 +50558,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -48365,16 +50613,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -48414,18 +50668,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -48464,16 +50726,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -48505,16 +50773,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -48553,18 +50827,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -48597,16 +50879,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -48642,18 +50930,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48692,16 +50988,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -48739,16 +51041,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -48795,18 +51103,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api updateApiKey --help /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -48848,16 +51164,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -48908,18 +51230,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -48970,16 +51300,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -49027,16 +51363,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -49071,18 +51413,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -49127,16 +51477,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -49198,16 +51554,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -49254,16 +51616,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -49294,16 +51662,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -49350,16 +51724,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49398,16 +51778,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -49444,18 +51830,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -49492,18 +51886,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49540,16 +51942,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -49587,16 +51995,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -49642,18 +52056,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -49744,16 +52166,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -49797,16 +52225,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -49851,16 +52285,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -49889,16 +52329,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -49929,16 +52375,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -49966,16 +52418,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -50010,18 +52468,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns list of Service Accounts with service account details. @@ -50052,16 +52518,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" post: description: Create Service Account containing client id and client secrets. operationId: createServiceAccount @@ -50096,18 +52568,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: delete: description: Delete Service Account. @@ -50140,16 +52620,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" get: description: Get Service Account Details. operationId: getServiceAccount @@ -50183,16 +52669,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account. operationId: updateServiceAccount @@ -50235,18 +52727,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: get: description: Returns list of Service Account projects. @@ -50283,16 +52783,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccountProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: post: description: Create Service Account secret. @@ -50334,18 +52840,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: delete: description: Delete Service Account Secret. @@ -50384,16 +52898,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50424,16 +52944,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -50470,18 +52996,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -50518,16 +53052,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -50569,18 +53109,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50623,16 +53171,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -50674,16 +53228,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -50734,18 +53294,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -50792,16 +53360,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -50854,18 +53428,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50915,16 +53497,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -50964,16 +53552,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -51007,16 +53601,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -51057,16 +53657,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -51113,18 +53719,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access). @@ -51145,16 +53759,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllControlPlaneIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" /api/atlas/v2/users: post: description: |- @@ -51194,18 +53814,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ - --header "Content-Type: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -51242,16 +53870,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -51286,16 +53920,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2024-08-05+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json index 20b288a2e5..9989ccd6eb 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json @@ -250,13 +250,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSystemStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSystemStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2?pretty=true\"" } ] } @@ -307,13 +312,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationMatchersFieldNames --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true\"" } ] } @@ -370,13 +380,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClustersForAllProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClustersForAllProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true\"" } ] } @@ -433,13 +448,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listEventTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listEventTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true\"" } ] } @@ -487,13 +507,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederationApp --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederationApp --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}\"" } ] } @@ -553,13 +578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listConnectedOrgConfigs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listConnectedOrgConfigs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true\"" } ] } @@ -626,13 +656,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api removeConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\"" } ] }, @@ -697,13 +732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true\"" } ] }, @@ -779,13 +819,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateConnectedOrgConfig --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateConnectedOrgConfig --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}\" \\\n -d '{ }'" } ] } @@ -842,13 +887,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listRoleMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listRoleMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true\"" } ] }, @@ -914,13 +964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings\" \\\n -d '{ }'" } ] } @@ -987,13 +1042,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + "label": "Atlas CLI", + "source": "atlas api deleteRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\"" } ] }, @@ -1061,13 +1121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRoleMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRoleMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true\"" } ] }, @@ -1146,13 +1211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateRoleMapping --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateRoleMapping --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}\" \\\n -d '{ }'" } ] } @@ -1244,13 +1314,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIdentityProviders --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listIdentityProviders --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true\"" } ] }, @@ -1316,13 +1391,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders\" \\\n -d '{ }'" } ] } @@ -1383,13 +1463,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\"" } ] }, @@ -1454,13 +1539,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true\"" } ] }, @@ -1533,13 +1623,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}\" \\\n -d '{ }'" } ] } @@ -1600,13 +1695,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + "label": "Atlas CLI", + "source": "atlas api revokeJwksFromIdentityProvider --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api revokeJwksFromIdentityProvider --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks\"" } ] } @@ -1660,13 +1760,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIdentityProviderMetadata --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getIdentityProviderMetadata --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true\"" } ] } @@ -1726,13 +1831,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true\"" } ] }, @@ -1812,13 +1922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups\" \\\n -d '{ }'" } ] } @@ -1886,13 +2001,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true\"" } ] } @@ -1946,13 +2066,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\"" } ] }, @@ -2004,13 +2129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true\"" } ] }, @@ -2079,13 +2209,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}\" \\\n -d '{ }'" } ] } @@ -2155,13 +2290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addUserToProject --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addUserToProject --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access\" \\\n -d '{ }'" } ] } @@ -2225,13 +2365,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectIpAccessLists --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectIpAccessLists --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true\"" } ] }, @@ -2313,13 +2458,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList\" \\\n -d '{ }'" } ] } @@ -2388,13 +2538,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectIpAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectIpAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}\"" } ] }, @@ -2464,13 +2619,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true\"" } ] } @@ -2541,13 +2701,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectIpAccessListStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectIpAccessListStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true\"" } ] } @@ -2607,13 +2772,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true\"" } ] }, @@ -2676,13 +2846,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs\" \\\n -d '{ }'" } ] } @@ -2746,13 +2921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\"" } ] }, @@ -2817,13 +2997,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true\"" } ] }, @@ -2899,13 +3084,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] }, @@ -2984,13 +3174,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAlertConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAlertConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}\" \\\n -d '{ }'" } ] } @@ -3066,13 +3261,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertsByAlertConfigurationId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertsByAlertConfigurationId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true\"" } ] } @@ -3148,13 +3348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlerts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlerts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true\"" } ] } @@ -3220,13 +3425,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true\"" } ] }, @@ -3304,13 +3514,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api acknowledgeAlert --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api acknowledgeAlert --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}\" \\\n -d '{ }'" } ] } @@ -3385,13 +3600,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAlertConfigurationsByAlertId --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAlertConfigurationsByAlertId --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true\"" } ] } @@ -3455,13 +3675,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectApiKeys --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectApiKeys --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true\"" } ] }, @@ -3521,13 +3746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -3597,13 +3827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\"" } ] }, @@ -3687,13 +3922,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKeyRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKeyRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] }, @@ -3768,13 +4008,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -3825,13 +4070,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true\"" } ] }, @@ -3894,13 +4144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAuditingConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAuditingConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog\" \\\n -d '{ }'" } ] } @@ -3951,13 +4206,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true\"" } ] }, @@ -4017,13 +4277,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleAWSCustomDNS --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleAWSCustomDNS --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS\" \\\n -d '{ }'" } ] } @@ -4083,13 +4348,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listExportBuckets --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listExportBuckets --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true\"" } ] }, @@ -4210,13 +4480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createExportBucket --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createExportBucket --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets\" \\\n -d '{ }'" } ] } @@ -4283,13 +4558,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}\"" } ] }, @@ -4385,13 +4665,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getExportBucket --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getExportBucket --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true\"" } ] } @@ -4445,13 +4730,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true\"" } ] }, @@ -4527,13 +4817,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDataProtectionSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDataProtectionSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy\" \\\n -d '{ }'" } ] } @@ -4584,13 +4879,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderAccessRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderAccessRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true\"" } ] }, @@ -4654,13 +4954,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess\" \\\n -d '{ }'" } ] } @@ -4735,13 +5040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + "label": "Atlas CLI", + "source": "atlas api deauthorizeCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deauthorizeCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}\"" } ] } @@ -4804,13 +5114,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCloudProviderAccessRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCloudProviderAccessRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true\"" } ] }, @@ -4892,13 +5207,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api authorizeCloudProviderAccessRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api authorizeCloudProviderAccessRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}\" \\\n -d '{ }'" } ] } @@ -4967,13 +5287,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listClusters --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listClusters --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true\"" } ] }, @@ -5052,13 +5377,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters\" \\\n -d '{ }'" } ] } @@ -5137,13 +5467,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCloudProviderRegions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCloudProviderRegions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true\"" } ] } @@ -5217,13 +5552,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade\" \\\n -d '{ }'" } ] } @@ -5297,13 +5637,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api upgradeSharedClusterToServerless --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api upgradeSharedClusterToServerless --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless\" \\\n -d '{ }'" } ] } @@ -5380,13 +5725,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\"" } ] }, @@ -5453,13 +5803,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true\"" } ] }, @@ -5541,13 +5896,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}\" \\\n -d '{ }'" } ] } @@ -5619,13 +5979,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupExportJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupExportJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true\"" } ] }, @@ -5703,13 +6068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports\" \\\n -d '{ }'" } ] } @@ -5778,13 +6148,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupExportJob --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupExportJob --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true\"" } ] } @@ -5856,13 +6231,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -5943,13 +6323,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -6027,13 +6412,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + "label": "Atlas CLI", + "source": "atlas api cancelBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cancelBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}\"" } ] }, @@ -6106,13 +6496,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -6175,13 +6570,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllBackupSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllBackupSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\"" } ] }, @@ -6242,13 +6642,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getBackupSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getBackupSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true\"" } ] }, @@ -6323,13 +6728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateBackupSchedule --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateBackupSchedule --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule\" \\\n -d '{ }'" } ] } @@ -6404,13 +6814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listReplicaSetBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listReplicaSetBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true\"" } ] }, @@ -6485,13 +6900,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api takeSnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api takeSnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots\" \\\n -d '{ }'" } ] } @@ -6566,13 +6986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}\"" } ] }, @@ -6648,13 +7073,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getShardedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getShardedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true\"" } ] } @@ -6720,13 +7150,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listShardedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listShardedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true\"" } ] } @@ -6804,13 +7239,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\"" } ] }, @@ -6886,13 +7326,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getReplicaSetBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getReplicaSetBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -6979,13 +7424,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateSnapshotRetention --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateSnapshotRetention --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -7071,13 +7521,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api downloadSharedClusterBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadSharedClusterBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download\" \\\n -d '{ }'" } ] } @@ -7160,13 +7615,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore\" \\\n -d '{ }'" } ] } @@ -7232,13 +7692,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true\"" } ] } @@ -7316,13 +7781,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true\"" } ] } @@ -7388,13 +7858,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSharedClusterBackups --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSharedClusterBackups --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true\"" } ] } @@ -7472,13 +7947,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSharedClusterBackup --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSharedClusterBackup --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -7551,13 +8031,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupCheckpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupCheckpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true\"" } ] } @@ -7639,13 +8124,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupCheckpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupCheckpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true\"" } ] } @@ -7711,13 +8201,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPinnedNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPinnedNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true\"" } ] }, @@ -7803,13 +8298,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPatch --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPatch --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] }, @@ -7895,13 +8395,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinNamespacesPut --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinNamespacesPut --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned\" \\\n -d '{ }'" } ] } @@ -7978,13 +8483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinNamespaces --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinNamespaces --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin\" \\\n -d '{ }'" } ] } @@ -8069,13 +8579,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8165,13 +8680,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8255,13 +8775,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexDeprecated --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexDeprecated --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\"" } ], "x-sunset": "2025-06-01" @@ -8340,13 +8865,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true\"" } ], "x-sunset": "2025-06-01" @@ -8442,13 +8972,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexDeprecated --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexDeprecated --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}\" \\\n -d '{ }'" } ], "x-sunset": "2025-06-01" @@ -8516,13 +9051,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedNamespace --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedNamespace --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true\"" } ] } @@ -8589,13 +9129,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteAllCustomZoneMappings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAllCustomZoneMappings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\"" } ] }, @@ -8675,13 +9220,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomZoneMapping --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomZoneMapping --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping\" \\\n -d '{ }'" } ] } @@ -8767,13 +9317,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + "label": "Atlas CLI", + "source": "atlas api deleteManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\"" } ] }, @@ -8856,13 +9411,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createManagedNamespace --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createManagedNamespace --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces\" \\\n -d '{ }'" } ] } @@ -9031,13 +9591,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createRollingIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createRollingIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index\" \\\n -d '{ }'" } ] } @@ -9113,13 +9678,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOnlineArchives --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOnlineArchives --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true\"" } ] }, @@ -9204,13 +9774,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOnlineArchive --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOnlineArchive --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives\" \\\n -d '{ }'" } ] } @@ -9313,13 +9888,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadOnlineArchiveQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadOnlineArchiveQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true\"" } ] } @@ -9401,13 +9981,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\"" } ] }, @@ -9490,13 +10075,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true\"" } ] }, @@ -9593,13 +10183,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOnlineArchive --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOnlineArchive --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}\" \\\n -d '{ }'" } ] } @@ -9672,13 +10267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + "label": "Atlas CLI", + "source": "atlas api endOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api endOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\"" } ] }, @@ -9749,13 +10349,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOutageSimulation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOutageSimulation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true\"" } ] }, @@ -9834,13 +10439,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startOutageSimulation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startOutageSimulation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation\" \\\n -d '{ }'" } ] } @@ -9910,13 +10520,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterAdvancedConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterAdvancedConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true\"" } ] }, @@ -9999,13 +10614,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateClusterAdvancedConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateClusterAdvancedConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs\" \\\n -d '{ }'" } ] } @@ -10065,13 +10685,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api testFailover --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api testFailover --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries\" \\\n -d '{ }'" } ] } @@ -10158,13 +10783,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacyBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacyBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true\"" } ] }, @@ -10240,13 +10870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs\" \\\n -d '{ }'" } ] } @@ -10325,13 +10960,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacyBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacyBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true\"" } ] } @@ -10400,13 +11040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\"" } ] }, @@ -10470,13 +11115,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true\"" } ] }, @@ -10554,13 +11204,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchDeployment --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchDeployment --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] }, @@ -10638,13 +11293,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchDeployment --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchDeployment --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment\" \\\n -d '{ }'" } ] } @@ -10727,13 +11387,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexesCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexesCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true\"" } ] }, @@ -10815,13 +11480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes\" \\\n -d '{ }'" } ] } @@ -10922,13 +11592,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasSearchIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasSearchIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true\"" } ] } @@ -11025,13 +11700,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\"" } ] }, @@ -11126,13 +11806,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndexByName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndexByName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true\"" } ] }, @@ -11241,13 +11926,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndexByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndexByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}\" \\\n -d '{ }'" } ] } @@ -11329,13 +12019,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteAtlasSearchIndex --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteAtlasSearchIndex --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\"" } ] }, @@ -11425,13 +12120,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true\"" } ] }, @@ -11525,13 +12225,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateAtlasSearchIndex --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateAtlasSearchIndex --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}\" \\\n -d '{ }'" } ] } @@ -11595,13 +12300,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true\"" } ] }, @@ -11674,13 +12384,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotSchedule --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotSchedule --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule\" \\\n -d '{ }'" } ] } @@ -11767,13 +12482,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listLegacySnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listLegacySnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true\"" } ] } @@ -11852,13 +12572,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteLegacySnapshot --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLegacySnapshot --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\"" } ] }, @@ -11932,13 +12657,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLegacySnapshot --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLegacySnapshot --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true\"" } ] }, @@ -12023,13 +12753,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateLegacySnapshotRetention --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateLegacySnapshotRetention --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}\" \\\n -d '{ }'" } ] } @@ -12092,13 +12827,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getClusterStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getClusterStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true\"" } ] } @@ -12181,13 +12921,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForCluster --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true\"" } ] } @@ -12323,13 +13068,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceClusterMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -12412,13 +13162,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12493,13 +13248,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api unpinFeatureCompatibilityVersion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api unpinFeatureCompatibilityVersion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion\" \\\n -d '{ }'" } ] } @@ -12610,13 +13370,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true\"" } ] } @@ -12670,13 +13435,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceMetrics --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true\"" } ] } @@ -12754,13 +13524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainerByCloudProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainerByCloudProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true\"" } ] }, @@ -12832,13 +13607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers\" \\\n -d '{ }'" } ] } @@ -12898,13 +13678,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringContainers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringContainers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true\"" } ] } @@ -12977,13 +13762,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\"" } ] }, @@ -13045,13 +13835,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true\"" } ] }, @@ -13136,13 +13931,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringContainer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringContainer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}\" \\\n -d '{ }'" } ] } @@ -13196,13 +13996,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listCustomDatabaseRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listCustomDatabaseRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true\"" } ] }, @@ -13274,13 +14079,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles\" \\\n -d '{ }'" } ] } @@ -13346,13 +14156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteCustomDatabaseRole --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteCustomDatabaseRole --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\"" } ] }, @@ -13413,13 +14228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true\"" } ] }, @@ -13500,13 +14320,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateCustomDatabaseRole --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateCustomDatabaseRole --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}\" \\\n -d '{ }'" } ] } @@ -13573,13 +14398,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listFederatedDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listFederatedDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true\"" } ] }, @@ -13648,13 +14478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation\" \\\n -d '{ }'" } ] } @@ -13714,13 +14549,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\"" } ] }, @@ -13781,13 +14621,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederatedDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederatedDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true\"" } ] }, @@ -13868,13 +14713,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateFederatedDatabase --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateFederatedDatabase --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}\" \\\n -d '{ }'" } ] } @@ -13940,13 +14790,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimits --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimits --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true\"" } ] } @@ -14018,13 +14873,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOneDataFederationInstanceQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\"" } ] }, @@ -14097,13 +14957,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnFederatedDatabaseQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnFederatedDatabaseQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true\"" } ] }, @@ -14190,13 +15055,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOneDataFederationQueryLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOneDataFederationQueryLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -14286,13 +15156,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadFederatedDatabaseQueryLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadFederatedDatabaseQueryLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true\"" } ] } @@ -14352,13 +15227,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true\"" } ] }, @@ -14582,13 +15462,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers\" \\\n -d '{ }'" } ] } @@ -14664,13 +15549,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\"" } ] }, @@ -14741,13 +15631,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true\"" } ] }, @@ -14838,13 +15733,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateDatabaseUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateDatabaseUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}\" \\\n -d '{ }'" } ] } @@ -14916,13 +15816,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabaseUserCertificates --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabaseUserCertificates --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true\"" } ] }, @@ -15008,13 +15913,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDatabaseUserCertificate --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDatabaseUserCertificate --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs\" \\\n -d '{ }'" } ] } @@ -15131,13 +16041,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByClusterName --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByClusterName --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"" } ] } @@ -15251,13 +16166,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAccessLogsByHostname --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAccessLogsByHostname --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true\"" } ] } @@ -15308,13 +16228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRest --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRest --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true\"" } ] }, @@ -15383,13 +16308,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateEncryptionAtRest --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateEncryptionAtRest --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest\" \\\n -d '{ }'" } ] } @@ -15452,13 +16382,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true\"" } ] }, @@ -15530,13 +16465,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints\" \\\n -d '{ }'" } ] } @@ -15622,13 +16562,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api requestEncryptionAtRestPrivateEndpointDeletion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}\"" } ] }, @@ -15701,13 +16646,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getEncryptionAtRestPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true\"" } ] } @@ -15834,13 +16784,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true\"" } ] } @@ -15915,13 +16870,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true\"" } ] } @@ -15975,13 +16935,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listMetricTypes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listMetricTypes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true\"" } ] } @@ -16081,13 +17046,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listIndexMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/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" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true\"" } ] } @@ -16190,13 +17160,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getIndexMetrics --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/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" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true\"" } ] } @@ -16291,13 +17266,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true\"" } ] } @@ -16363,13 +17343,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listThirdPartyIntegrations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listThirdPartyIntegrations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true\"" } ] } @@ -16448,13 +17433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + "label": "Atlas CLI", + "source": "atlas api deleteThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\"" } ] }, @@ -16531,13 +17521,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true\"" } ] }, @@ -16637,13 +17632,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] }, @@ -16740,13 +17740,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateThirdPartyIntegration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateThirdPartyIntegration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}\" \\\n -d '{ }'" } ] } @@ -16810,13 +17815,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectInvitations --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectInvitations --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -16884,13 +17894,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -16952,13 +17967,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17020,13 +18040,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\"" } ], "x-sunset": "2024-10-04" @@ -17092,13 +18117,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true\"" } ], "x-sunset": "2024-10-04" @@ -17175,13 +18205,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}\" \\\n -d '{ }'" } ], "x-sunset": "2024-10-04" @@ -17236,13 +18271,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true\"" } ] } @@ -17305,13 +18345,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectLimits --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectLimits --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true\"" } ] } @@ -17392,13 +18437,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\"" } ] }, @@ -17480,13 +18530,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLimit --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLimit --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true\"" } ] }, @@ -17579,13 +18634,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setProjectLimit --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setProjectLimit --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}\" \\\n -d '{ }'" } ] } @@ -17657,13 +18717,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations\" \\\n -d '{ }'" } ] } @@ -17735,13 +18800,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api validateMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api validateMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate\" \\\n -d '{ }'" } ] } @@ -17811,13 +18881,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getValidationStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getValidationStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true\"" } ] } @@ -17877,13 +18952,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true\"" } ] } @@ -17943,13 +19023,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api cutoverMigration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api cutoverMigration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover\" \\\n -d '{ }'" } ] } @@ -17997,13 +19082,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" + "label": "Atlas CLI", + "source": "atlas api resetMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resetMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\"" } ] }, @@ -18052,13 +19142,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getMaintenanceWindow --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getMaintenanceWindow --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true\"" } ] }, @@ -18118,13 +19213,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow\" \\\n -d '{ }'" } ] } @@ -18172,13 +19272,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleMaintenanceAutoDefer --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleMaintenanceAutoDefer --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer\" \\\n -d '{ }'" } ] } @@ -18226,13 +19331,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api deferMaintenanceWindow --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deferMaintenanceWindow --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer\" \\\n -d '{ }'" } ] } @@ -18283,13 +19393,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getManagedSlowMs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getManagedSlowMs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true\"" } ] } @@ -18340,13 +19455,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + "label": "Atlas CLI", + "source": "atlas api disableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable\"" } ] } @@ -18397,13 +19517,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api enableSlowOperationThresholding --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api enableSlowOperationThresholding --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable\" \\\n -d '{ }'" } ] } @@ -18515,13 +19640,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectLTSVersions --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectLTSVersions --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true\"" } ] } @@ -18598,13 +19728,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPeeringConnections --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPeeringConnections --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true\"" } ] }, @@ -18677,13 +19812,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers\" \\\n -d '{ }'" } ] } @@ -18749,13 +19889,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\"" } ] }, @@ -18819,13 +19964,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true\"" } ] }, @@ -18906,13 +20056,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePeeringConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePeeringConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}\" \\\n -d '{ }'" } ] } @@ -18966,13 +20121,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelines --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelines --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true\"" } ] }, @@ -19035,13 +20195,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines\" \\\n -d '{ }'" } ] } @@ -19104,13 +20269,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\"" } ] }, @@ -19174,13 +20344,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipeline --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipeline --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true\"" } ] }, @@ -19258,13 +20433,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}\" \\\n -d '{ }'" } ] } @@ -19333,13 +20513,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSchedules --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSchedules --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true\"" } ] } @@ -19424,13 +20609,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineSnapshots --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineSnapshots --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true\"" } ] } @@ -19496,13 +20686,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api pausePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api pausePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause\" \\\n -d '{ }'" } ] } @@ -19568,13 +20763,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api resumePipeline --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api resumePipeline --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume\" \\\n -d '{ }'" } ] } @@ -19659,13 +20859,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPipelineRuns --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPipelineRuns --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true\"" } ] } @@ -19744,13 +20949,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePipelineRunDataset --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePipelineRunDataset --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}\"" } ] }, @@ -19827,13 +21037,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPipelineRun --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPipelineRun --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true\"" } ] } @@ -19910,13 +21125,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api triggerSnapshotIngestion --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api triggerSnapshotIngestion --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger\" \\\n -d '{ }'" } ] } @@ -19982,13 +21202,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService\" \\\n -d '{ }'" } ] } @@ -20042,13 +21267,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true\"" } ] }, @@ -20111,13 +21341,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api toggleRegionalizedPrivateEndpointSetting --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode\" \\\n -d '{ }'" } ] } @@ -20182,13 +21417,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true\"" } ] }, @@ -20263,13 +21503,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint\" \\\n -d '{ }'" } ] } @@ -20343,13 +21588,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\"" } ] }, @@ -20421,13 +21671,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true\"" } ] }, @@ -20510,13 +21765,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}\" \\\n -d '{ }'" } ] } @@ -20585,13 +21845,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPrivateEndpointServices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPrivateEndpointServices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true\"" } ] } @@ -20669,13 +21934,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpointService --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpointService --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}\"" } ] }, @@ -20754,13 +22024,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpointService --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpointService --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true\"" } ] } @@ -20858,13 +22133,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint\" \\\n -d '{ }'" } ] } @@ -20952,13 +22232,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deletePrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}\"" } ] }, @@ -21047,13 +22332,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPrivateEndpoint --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPrivateEndpoint --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true\"" } ] } @@ -21109,13 +22399,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyConnectViaPeeringOnlyModeForOneProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true\"" } ] }, @@ -21183,13 +22478,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api disablePeering --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disablePeering --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode\" \\\n -d '{ }'" } ] } @@ -21255,13 +22555,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDataFederationPrivateEndpoints --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDataFederationPrivateEndpoints --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true\"" } ] }, @@ -21324,13 +22629,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds\" \\\n -d '{ }'" } ] } @@ -21396,13 +22706,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}\"" } ] }, @@ -21469,13 +22784,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDataFederationPrivateEndpoint --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDataFederationPrivateEndpoint --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true\"" } ] } @@ -21535,13 +22855,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listAtlasProcesses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listAtlasProcesses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true\"" } ] } @@ -21603,13 +22928,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getAtlasProcess --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getAtlasProcess --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true\"" } ] } @@ -21669,13 +22999,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespacesForHost --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true\"" } ] } @@ -21746,13 +23081,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDatabases --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDatabases --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true\"" } ] } @@ -21823,13 +23163,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabase --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabase --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true\"" } ] } @@ -21939,13 +23284,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDatabaseMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDatabaseMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true\"" } ] } @@ -22016,13 +23366,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskPartitions --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskPartitions --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true\"" } ] } @@ -22090,13 +23445,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true\"" } ] } @@ -22215,13 +23575,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getDiskMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getDiskMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true\"" } ] } @@ -22447,13 +23812,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getHostMeasurements --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getHostMeasurements --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true\"" } ] } @@ -22533,13 +23903,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueryNamespaces --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueryNamespaces --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true\"" } ] } @@ -22643,13 +24018,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSlowQueries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSlowQueries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true\"" } ] } @@ -22769,13 +24149,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSuggestedIndexes --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSuggestedIndexes --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true\"" } ] } @@ -22886,13 +24271,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getCollStatsLatencyNamespaceHostMeasurements --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true\"" } ] } @@ -22949,13 +24339,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + "label": "Atlas CLI", + "source": "atlas api deletePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deletePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\"" } ] }, @@ -23010,13 +24405,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getPushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getPushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true\"" } ] }, @@ -23083,13 +24483,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updatePushBasedLogConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updatePushBasedLogConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] }, @@ -23156,13 +24561,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createPushBasedLogConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createPushBasedLogConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport\" \\\n -d '{ }'" } ] } @@ -23228,13 +24638,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api loadSampleDataset --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api loadSampleDataset --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}\" \\\n -d '{ }'" } ] } @@ -23294,13 +24709,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getSampleDatasetLoadStatus --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getSampleDatasetLoadStatus --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true\"" } ] } @@ -23360,13 +24780,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true\"" } ] }, @@ -23432,13 +24857,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless\" \\\n -d '{ }'" } ] } @@ -23513,13 +24943,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackupRestoreJobs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackupRestoreJobs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true\"" } ] }, @@ -23600,13 +25035,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs\" \\\n -d '{ }'" } ] } @@ -23684,13 +25124,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackupRestoreJob --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackupRestoreJob --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true\"" } ] } @@ -23765,13 +25210,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServerlessBackups --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServerlessBackups --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true\"" } ] } @@ -23847,13 +25297,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessBackup --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessBackup --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true\"" } ] } @@ -23916,13 +25371,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true\"" } ] }, @@ -23989,13 +25449,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api setServerlessAutoIndexing --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api setServerlessAutoIndexing --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing\" \\\n -d '{ }'" } ] } @@ -24064,13 +25529,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\"" } ] }, @@ -24137,13 +25607,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true\"" } ] }, @@ -24218,13 +25693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServerlessInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServerlessInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}\" \\\n -d '{ }'" } ] } @@ -24284,13 +25764,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true\"" } ] }, @@ -24354,13 +25839,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -24424,13 +25914,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteProjectServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteProjectServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -24491,13 +25986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -24572,13 +26072,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] }, @@ -24655,13 +26160,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addProjectServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addProjectServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -24718,13 +26228,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true\"" } ] }, @@ -24790,13 +26305,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings\" \\\n -d '{ }'" } ] } @@ -24853,13 +26373,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true\"" } ] }, @@ -24922,13 +26447,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams\" \\\n -d '{ }'" } ] } @@ -24994,13 +26524,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\"" } ] }, @@ -25069,13 +26604,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true\"" } ] }, @@ -25153,13 +26693,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}\" \\\n -d '{ }'" } ] } @@ -25252,13 +26797,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadStreamTenantAuditLogs --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadStreamTenantAuditLogs --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true\"" } ] } @@ -25327,13 +26877,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamConnections --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamConnections --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true\"" } ] }, @@ -25408,13 +26963,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections\" \\\n -d '{ }'" } ] } @@ -25489,13 +27049,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamConnection --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamConnection --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\"" } ] }, @@ -25562,13 +27127,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true\"" } ] }, @@ -25655,13 +27225,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateStreamConnection --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateStreamConnection --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}\" \\\n -d '{ }'" } ] } @@ -25738,13 +27313,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor\" \\\n -d '{ }'" } ] } @@ -25816,13 +27396,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + "label": "Atlas CLI", + "source": "atlas api deleteStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}\"" } ] }, @@ -25895,13 +27480,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true\"" } ] } @@ -25976,13 +27566,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api startStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api startStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start\" \\\n -d '{ }'" } ] } @@ -26057,13 +27652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api stopStreamProcessor --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api stopStreamProcessor --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop\" \\\n -d '{ }'" } ] } @@ -26138,13 +27738,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listStreamProcessors --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listStreamProcessors --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true\"" } ] } @@ -26213,13 +27818,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectTeams --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectTeams --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true\"" } ] }, @@ -26295,13 +27905,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addAllTeamsToProject --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addAllTeamsToProject --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams\" \\\n -d '{ }'" } ] } @@ -26371,13 +27986,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\"" } ] }, @@ -26462,13 +28082,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateTeamRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateTeamRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -26519,13 +28144,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true\"" } ] }, @@ -26588,13 +28218,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api saveLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api saveLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity\" \\\n -d '{ }'" } ] } @@ -26642,13 +28277,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + "label": "Atlas CLI", + "source": "atlas api disableCustomerManagedX509 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api disableCustomerManagedX509 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509\"" } ] } @@ -26699,13 +28339,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + "label": "Atlas CLI", + "source": "atlas api deleteLDAPConfiguration --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLDAPConfiguration --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping\"" } ] } @@ -26770,13 +28415,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api verifyLDAPConfiguration --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api verifyLDAPConfiguration --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify\" \\\n -d '{ }'" } ] } @@ -26839,13 +28489,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getLDAPConfigurationStatus --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getLDAPConfigurationStatus --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true\"" } ] } @@ -26923,13 +28578,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listProjectUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listProjectUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true\"" } ] } @@ -26995,13 +28655,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeProjectUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeProjectUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}\"" } ] } @@ -27081,13 +28746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateProjectRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateProjectRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -27147,13 +28817,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listUSSInstances --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listUSSInstances --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss?pretty=true\"" } ] }, @@ -27219,13 +28894,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUSSInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUSSInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss\" \\\n -d '{ }'" } ] } @@ -27294,13 +28974,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\"" + "label": "Atlas CLI", + "source": "atlas api deleteUSSInstance --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteUSSInstance --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\"" } ], "x-xgen-changelog": { @@ -27370,13 +29055,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUSSInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUSSInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}?pretty=true\"" } ] }, @@ -27451,13 +29141,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateUSSInstance --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateUSSInstance --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}\" \\\n -d '{ }'" } ] } @@ -27516,13 +29211,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api migrateProjectToAnotherOrg --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api migrateProjectToAnotherOrg --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate\" \\\n -d '{ }'" } ] } @@ -27596,13 +29296,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true\"" } ] }, @@ -27671,13 +29376,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs\" \\\n -d '{ }'" } ] } @@ -27737,13 +29447,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\"" } ] }, @@ -27801,13 +29516,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true\"" } ] }, @@ -27876,13 +29596,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameOrganization --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameOrganization --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}\" \\\n -d '{ }'" } ] } @@ -27946,13 +29671,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeys --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeys --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true\"" } ] }, @@ -28016,13 +29746,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKey --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKey --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys\" \\\n -d '{ }'" } ] } @@ -28089,13 +29824,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\"" } ] }, @@ -28160,13 +29900,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true\"" } ] }, @@ -28245,13 +29990,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateApiKey --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateApiKey --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}\" \\\n -d '{ }'" } ] } @@ -28327,13 +30077,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listApiKeyAccessListsEntries --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listApiKeyAccessListsEntries --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true\"" } ] }, @@ -28423,13 +30178,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createApiKeyAccessList --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createApiKeyAccessList --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList\" \\\n -d '{ }'" } ] } @@ -28513,13 +30273,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + "label": "Atlas CLI", + "source": "atlas api deleteApiKeyAccessListEntry --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteApiKeyAccessListEntry --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}\"" } ] }, @@ -28598,13 +30363,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getApiKeyAccessList --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getApiKeyAccessList --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true\"" } ] } @@ -28666,13 +30436,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage\" \\\n -d '{ }'" } ] } @@ -28747,13 +30522,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api createCostExplorerQueryProcess_1 --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createCostExplorerQueryProcess_1 --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true\"" } ] } @@ -28852,13 +30632,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationEvents --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationEvents --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true\"" } ] } @@ -28933,13 +30718,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationEvent --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationEvent --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true\"" } ] } @@ -28996,13 +30786,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getFederationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getFederationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true\"" } ] } @@ -29076,13 +30871,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true\"" } ] } @@ -29151,13 +30951,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationInvitations --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationInvitations --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true\"" } ] }, @@ -29223,13 +31028,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] }, @@ -29295,13 +31105,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites\" \\\n -d '{ }'" } ] } @@ -29367,13 +31182,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteOrganizationInvitation --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteOrganizationInvitation --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\"" } ] }, @@ -29437,13 +31257,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationInvitation --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationInvitation --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true\"" } ] }, @@ -29521,13 +31346,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationInvitationById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationInvitationById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}\" \\\n -d '{ }'" } ] } @@ -29669,13 +31499,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true\"" } ] } @@ -29729,13 +31564,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listPendingInvoices --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listPendingInvoices --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true\"" } ] } @@ -29807,13 +31647,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getInvoice --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getInvoice --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true\"" } ] } @@ -29878,13 +31723,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api downloadInvoiceCSV --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api downloadInvoiceCSV --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true\"" } ] } @@ -29964,13 +31814,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api queryLineItemsFromSingleInvoice --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api queryLineItemsFromSingleInvoice --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search?pretty=true\"" } ] } @@ -30027,13 +31882,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listSourceProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listSourceProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true\"" } ] } @@ -30084,13 +31944,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + "label": "Atlas CLI", + "source": "atlas api deleteLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\"" } ] }, @@ -30153,13 +32018,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createLinkToken --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createLinkToken --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens\" \\\n -d '{ }'" } ] } @@ -30219,13 +32089,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccounts --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccounts --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true\"" } ] }, @@ -30288,13 +32163,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts\" \\\n -d '{ }'" } ] } @@ -30354,13 +32234,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccount --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccount --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\"" } ] }, @@ -30421,13 +32306,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true\"" } ] }, @@ -30502,13 +32392,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateServiceAccount --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateServiceAccount --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}\" \\\n -d '{ }'" } ] } @@ -30577,13 +32472,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listServiceAccountProjects --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listServiceAccountProjects --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true\"" } ] } @@ -30657,13 +32557,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets\" \\\n -d '{ }'" } ] } @@ -30732,13 +32637,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteServiceAccountSecret --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteServiceAccountSecret --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}\"" } ] } @@ -30795,13 +32705,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true\"" } ] }, @@ -30867,13 +32782,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationSettings --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationSettings --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings\" \\\n -d '{ }'" } ] } @@ -30943,13 +32863,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationTeams --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationTeams --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true\"" } ] }, @@ -31022,13 +32947,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createTeam --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createTeam --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams\" \\\n -d '{ }'" } ] } @@ -31098,13 +33028,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamByName --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamByName --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true\"" } ] } @@ -31177,13 +33112,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + "label": "Atlas CLI", + "source": "atlas api deleteTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api deleteTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\"" } ] }, @@ -31254,13 +33194,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getTeamById --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getTeamById --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true\"" } ] }, @@ -31345,13 +33290,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api renameTeam --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api renameTeam --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PATCH \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}\" \\\n -d '{ }'" } ] } @@ -31433,13 +33383,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listTeamUsers --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listTeamUsers --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true\"" } ] }, @@ -31527,13 +33482,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api addTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api addTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users\" \\\n -d '{ }'" } ] } @@ -31615,13 +33575,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeTeamUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeTeamUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}\"" } ] } @@ -31687,13 +33652,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api listOrganizationUsers --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api listOrganizationUsers --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true\"" } ] } @@ -31762,13 +33732,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" + "label": "Atlas CLI", + "source": "atlas api removeOrganizationUser --help" + }, + { + "lang": "cURL", + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api removeOrganizationUser --help" + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X DELETE \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}\"" } ] } @@ -31848,13 +33823,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api updateOrganizationRoles --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api updateOrganizationRoles --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X PUT \"https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles\" \\\n -d '{ }'" } ] } @@ -31891,13 +33871,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api returnAllControlPlaneIPAddresses --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api returnAllControlPlaneIPAddresses --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true\"" } ] } @@ -31959,13 +33944,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/vnd.atlas.2025-01-01+json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + "label": "Atlas CLI", + "source": "atlas api createUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api createUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n --header \"Content-Type: application/json\" \\\n -X POST \"https://cloud.mongodb.com/api/atlas/v2/users\" \\\n -d '{ }'" } ] } @@ -32026,13 +34016,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUserByUsername --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUserByUsername --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true\"" } ] } @@ -32095,13 +34090,18 @@ "x-codeSamples": [ { "lang": "cURL", - "label": "curl", - "source": "curl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + "label": "Atlas CLI", + "source": "atlas api getUser --help" }, { "lang": "cURL", - "label": "Atlas CLI", - "source": "atlas api getUser --help" + "label": "curl (Service Accounts)", + "source": "curl --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" + }, + { + "lang": "cURL", + "label": "curl (Digest)", + "source": "curl --user \"${PUBLIC_KEY}:${PRIVATE_KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true\"" } ] } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml index d75a111268..aaa65e2be5 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml @@ -30556,16 +30556,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSystemStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSystemStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2?pretty=true" /api/atlas/v2/alertConfigs/matchers/fieldNames: get: description: Get all field names that the `matchers.fieldName` parameter accepts when you create or update an Alert Configuration. You can successfully call this endpoint with any assigned role. @@ -30593,16 +30599,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationMatchersFieldNames --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationMatchersFieldNames --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/alertConfigs/matchers/fieldNames?pretty=true" /api/atlas/v2/clusters: get: description: Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. @@ -30631,16 +30643,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClustersForAllProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClustersForAllProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/clusters?pretty=true" /api/atlas/v2/eventTypes: get: description: Returns a list of all event types, along with a description and additional metadata about each event. @@ -30669,16 +30687,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listEventTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listEventTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/eventTypes?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}: delete: description: 'Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. **Note**: requests to this resource will fail if there is more than one connected organization in the federation.' @@ -30705,16 +30729,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederationApp --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederationApp --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs: get: description: Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. @@ -30746,16 +30776,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listConnectedOrgConfigs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listConnectedOrgConfigs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs?pretty=true" /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}: delete: description: 'Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.' @@ -30795,16 +30831,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" get: description: Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. operationId: getConnectedOrgConfig @@ -30843,16 +30885,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}?pretty=true" patch: description: "Updates one connected organization configuration from the specified federation. To use this resource, the requesting 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." operationId: updateConnectedOrgConfig @@ -30898,18 +30946,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateConnectedOrgConfig --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateConnectedOrgConfig --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings: get: description: Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -30940,16 +30996,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listRoleMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listRoleMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings?pretty=true" post: description: Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createRoleMapping @@ -30986,18 +31048,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}: delete: description: Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. @@ -31036,16 +31106,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" get: description: Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getRoleMapping @@ -31085,16 +31161,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}?pretty=true" put: description: Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateRoleMapping @@ -31141,18 +31223,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateRoleMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateRoleMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings/{id}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders: get: description: Returns all identity providers with the provided protocol and type in the specified federation. If no protocol is specified, only SAML identity providers will be returned. If no idpType is specified, only WORKFORCE identity providers will be returned. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -31206,16 +31296,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIdentityProviders --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIdentityProviders --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders?pretty=true" post: description: |- Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -31256,18 +31352,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}: delete: description: "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/)." @@ -31302,16 +31406,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" get: description: 'Returns one identity provider in the specified federation by the identity provider''s id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. Deprecated versions: v2-{2023-01-01}' operationId: getIdentityProvider @@ -31349,16 +31459,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}?pretty=true" patch: description: |- Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -31404,18 +31520,26 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" \ + -d '{ }' /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks: delete: description: "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks)." @@ -31450,16 +31574,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api revokeJwksFromIdentityProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api revokeJwksFromIdentityProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" /api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml: get: description: Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. @@ -31489,16 +31619,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIdentityProviderMetadata --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIdentityProviderMetadata --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml?pretty=true" /api/atlas/v2/groups: get: description: Returns details about all projects. 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 API Key must have the Organization Read Only role or higher. @@ -31529,16 +31665,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups?pretty=true" 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 API Key must have the Read Write role. operationId: createProject @@ -31586,18 +31728,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ + -d '{ }' /api/atlas/v2/groups/{groupId}: delete: description: Removes 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. You can delete a project only if there are no Online Archives for the clusters in the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -31626,16 +31776,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" 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 API Key must have the Project Read Only role. operationId: getProject @@ -31663,16 +31819,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProject @@ -31711,18 +31873,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/access: post: description: Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role. @@ -31761,18 +31931,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addUserToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addUserToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/access" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList: get: description: Returns all access list entries 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 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31805,16 +31983,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectIpAccessLists --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectIpAccessLists --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList?pretty=true" post: description: Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Owner 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. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. This endpoint doesn't support concurrent `POST` requests. You must submit multiple `POST` requests synchronously. externalDocs: @@ -31859,18 +32043,26 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/accessList/{entryValue}: delete: description: Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Owner role. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations. @@ -31915,16 +32107,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectIpAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectIpAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}" 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 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. externalDocs: @@ -31965,16 +32163,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}?pretty=true" /api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status: get: description: Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project. @@ -32015,16 +32219,22 @@ paths: tags: - Project IP Access List x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectIpAccessListStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectIpAccessListStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/accessList/{entryValue}/status?pretty=true" /api/atlas/v2/groups/{groupId}/alertConfigs: get: description: |- @@ -32057,16 +32267,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs?pretty=true" post: description: |- Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -32104,18 +32320,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}: delete: description: |- @@ -32155,16 +32379,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" get: description: |- Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32205,16 +32435,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}?pretty=true" patch: description: |- Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -32264,18 +32500,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' put: description: |- Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -32327,18 +32571,26 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAlertConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAlertConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts: get: description: |- @@ -32383,16 +32635,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertsByAlertConfigurationId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertsByAlertConfigurationId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts: get: description: |- @@ -32436,16 +32694,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlerts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlerts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts?pretty=true" /api/atlas/v2/groups/{groupId}/alerts/{alertId}: get: description: |- @@ -32486,16 +32750,22 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}?pretty=true" patch: description: |- Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -32544,18 +32814,26 @@ paths: tags: - Alerts x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api acknowledgeAlert --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api acknowledgeAlert --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs: get: description: |- @@ -32599,16 +32877,22 @@ paths: tags: - Alert Configurations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAlertConfigurationsByAlertId --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAlertConfigurationsByAlertId --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}/alertConfigs?pretty=true" /api/atlas/v2/groups/{groupId}/apiKeys: get: description: Returns all organization API keys that you assigned 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 API Key must have the Project Owner role. @@ -32641,16 +32925,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys?pretty=true" 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 API Key must have the Project Owner role. operationId: createProjectApiKey @@ -32683,18 +32973,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -32735,16 +33033,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" 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. operationId: updateApiKeyRoles @@ -32791,18 +33095,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKeyRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKeyRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' 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 API Key must have the Project Owner role. operationId: addProjectApiKey @@ -32846,18 +33158,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/auditLog: get: description: Returns 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. @@ -32884,16 +33204,22 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog?pretty=true" 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 API Key must have the Project Owner role. This feature isn't available for `M0`, `M2`, `M5`, or serverless clusters. operationId: updateAuditingConfiguration @@ -32928,18 +33254,26 @@ paths: tags: - Auditing x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAuditingConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAuditingConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/auditLog" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/awsCustomDNS: get: description: Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -32966,16 +33300,22 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS?pretty=true" 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 API Key must have the Project Atlas Admin role. operationId: toggleAWSCustomDNS @@ -33008,18 +33348,26 @@ paths: tags: - AWS Clusters DNS x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleAWSCustomDNS --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleAWSCustomDNS --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/awsCustomDNS" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: description: 'Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -33049,16 +33397,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listExportBuckets --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listExportBuckets --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets?pretty=true" post: description: 'Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: createExportBucket @@ -33134,18 +33488,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createExportBucket --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createExportBucket --help /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: description: Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. Auto export must be disabled on all clusters in this Project exporting to this Export Bucket before revoking access. To use this resource, the requesting API Key must have the Project Owner role. @@ -33185,16 +33547,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" get: description: 'Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getExportBucket @@ -33254,16 +33622,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getExportBucket --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getExportBucket --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}?pretty=true" /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: description: 'Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' @@ -33292,16 +33666,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy?pretty=true" put: description: 'Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateDataProtectionSettings @@ -33345,18 +33725,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDataProtectionSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDataProtectionSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: Returns all cloud provider access roles with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33383,16 +33771,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderAccessRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderAccessRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -33428,18 +33822,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}: delete: description: Revokes access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. @@ -33483,16 +33885,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deauthorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deauthorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{cloudProvider}/{roleId}" /api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}: get: description: Returns the access role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -33528,16 +33936,22 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}?pretty=true" patch: description: Grants access to the specified project for the specified access role. To use this resource, the requesting 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. externalDocs: @@ -33586,18 +34000,26 @@ paths: tags: - Cloud Provider Access x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api authorizeCloudProviderAccessRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api authorizeCloudProviderAccessRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters: get: description: 'Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -33633,16 +34055,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listClusters --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listClusters --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true" post: description: 'Creates one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can create clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' operationId: createCluster @@ -33811,18 +34239,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}: delete: description: 'Removes one cluster from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-01-01}' @@ -33867,16 +34303,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" get: description: 'Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' operationId: getCluster @@ -33915,16 +34357,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true" 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 API Key must have the Project Owner role. For all other updates, the requesting 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-{2023-02-01}, v2-{2023-01-01}' operationId: updateCluster @@ -33973,18 +34421,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency cluster-level measurements for the given namespace. @@ -34074,16 +34530,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceClusterMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces: get: description: Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window. @@ -34131,16 +34593,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: description: Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -34179,16 +34647,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupExportJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupExportJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports?pretty=true" post: description: Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. operationId: createBackupExportJob @@ -34235,18 +34709,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: description: Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -34287,16 +34769,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupExportJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupExportJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: get: description: Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34335,16 +34823,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs?pretty=true" post: description: |- Restores one snapshot of one cluster from the specified project. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -34395,18 +34889,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}: delete: description: Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34453,16 +34955,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cancelBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cancelBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" get: description: Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: getBackupRestoreJob @@ -34506,16 +35014,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule: delete: description: 'Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. Deprecated versions: v2-{2023-01-01}' @@ -34552,16 +35066,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllBackupSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllBackupSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" 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 API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' operationId: getBackupSchedule @@ -34596,16 +35116,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getBackupSchedule --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getBackupSchedule --help 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 API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}' operationId: updateBackupSchedule @@ -34652,18 +35178,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateBackupSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateBackupSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -34704,16 +35238,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listReplicaSetBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listReplicaSetBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots?pretty=true" post: description: |- Takes one on-demand snapshot for the specified cluster. Atlas takes on-demand snapshots immediately and scheduled snapshots at regular intervals. If an on-demand snapshot with a status of **queued** or **inProgress** exists, before taking another snapshot, wait until Atlas completes completes processing the previously taken on-demand snapshot. @@ -34760,18 +35300,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api takeSnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api takeSnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}: delete: description: Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role. @@ -34818,16 +35366,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" get: description: Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getReplicaSetBackup @@ -34873,16 +35427,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getReplicaSetBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getReplicaSetBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" patch: description: Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. operationId: updateSnapshotRetention @@ -34935,18 +35495,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateSnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateSnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}: delete: description: Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -34991,16 +35559,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}" get: description: Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getShardedClusterBackup @@ -35046,16 +35620,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getShardedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getShardedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters: get: description: Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35093,16 +35673,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listShardedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listShardedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download: post: description: Requests one snapshot for the specified shared cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role. @@ -35153,18 +35739,26 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/download" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore: post: description: Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role. @@ -35213,18 +35807,26 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores: get: description: Returns all restore jobs for the specified M2 or M5 cluster. Restore jobs restore a cluster using a snapshot. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35262,16 +35864,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}: get: description: Returns the specified restore job. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35318,16 +35926,22 @@ paths: tags: - Shared-Tier Restore Jobs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restores/{restoreId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots: get: description: Returns details for all snapshots for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35365,16 +35979,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSharedClusterBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSharedClusterBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}: get: description: Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role. @@ -35421,16 +36041,22 @@ paths: tags: - Shared-Tier Snapshots x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSharedClusterBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSharedClusterBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints: get: deprecated: true @@ -35470,16 +36096,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupCheckpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupCheckpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}: get: deprecated: true @@ -35529,16 +36161,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupCheckpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupCheckpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned: get: description: Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on. @@ -35577,16 +36215,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPinnedNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPinnedNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned?pretty=true" patch: description: Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster operationId: pinNamespacesPatch @@ -35638,18 +36282,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPatch --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPatch --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' 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. operationId: pinNamespacesPut @@ -35701,18 +36353,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinNamespacesPut --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinNamespacesPut --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin: patch: description: Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster @@ -35758,18 +36418,26 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes: post: deprecated: true @@ -35820,18 +36488,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}: get: @@ -35886,16 +36562,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{databaseName}/{collectionName}?pretty=true" x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}: delete: @@ -35947,16 +36629,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" x-sunset: "2025-06-01" get: deprecated: true @@ -36005,16 +36693,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}?pretty=true" x-sunset: "2025-06-01" patch: deprecated: true @@ -36074,18 +36768,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexDeprecated --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexDeprecated --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/fts/indexes/{indexId}" \ + -d '{ }' x-sunset: "2025-06-01" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites: get: @@ -36125,16 +36827,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping: delete: description: 'Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -36173,16 +36881,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAllCustomZoneMappings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAllCustomZoneMappings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" 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 API Key must have the Project Owner role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: @@ -36230,18 +36944,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomZoneMapping --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomZoneMapping --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces: delete: description: 'Removes 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. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' @@ -36292,16 +37014,22 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" 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 API Key must have the Project Data Access Admin role. Deprecated versions: v2-{2023-02-01}, v2-{2023-01-01}' externalDocs: @@ -36351,18 +37079,26 @@ paths: tags: - Global Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createManagedNamespace --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createManagedNamespace --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/managedNamespaces" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index: post: description: Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -36473,18 +37209,26 @@ paths: tags: - Rolling Index x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createRollingIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createRollingIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives: get: description: Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -36526,16 +37270,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOnlineArchives --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOnlineArchives --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives?pretty=true" post: description: Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. externalDocs: @@ -36586,18 +37336,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}: delete: description: Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. @@ -36647,16 +37405,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" 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 API Key must have the Project Read Only role. externalDocs: @@ -36707,16 +37471,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -36776,18 +37546,26 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOnlineArchive --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOnlineArchive --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/{archiveId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz: get: description: 'Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -36853,16 +37631,22 @@ paths: tags: - Online Archive x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadOnlineArchiveQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadOnlineArchiveQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation: delete: description: Ends a cluster outage simulation. @@ -36905,16 +37689,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api endOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api endOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" get: description: Returns one outage simulation for one cluster. externalDocs: @@ -36956,16 +37746,22 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation?pretty=true" post: description: Starts a cluster outage simulation. externalDocs: @@ -37012,18 +37808,26 @@ paths: tags: - Cluster Outage Simulation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startOutageSimulation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startOutageSimulation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/outageSimulation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: 'Returns 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. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}' @@ -37064,16 +37868,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true" 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 API Key must have the Project Cluster Manager role. This feature isn''t available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. Deprecated versions: v2-{2023-01-01}' externalDocs: @@ -37123,18 +37933,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateClusterAdvancedConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateClusterAdvancedConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries: post: description: 'Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster''s primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. Deprecated versions: v2-{2023-01-01}' @@ -37168,18 +37986,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api testFailover --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api testFailover --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs: get: deprecated: true @@ -37232,16 +38058,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacyBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacyBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs?pretty=true" post: deprecated: true description: Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore. @@ -37286,18 +38118,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}: get: deprecated: true @@ -37348,16 +38188,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacyBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacyBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment: delete: description: Deletes the Search Nodes for the specified cluster. @@ -37397,16 +38243,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" get: description: 'Return the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: getAtlasSearchDeployment @@ -37443,16 +38295,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment?pretty=true" patch: description: 'Updates the Search Nodes for the specified cluster. Deprecated versions: v2-{2023-01-01}' operationId: updateAtlasSearchDeployment @@ -37498,18 +38356,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' post: description: Creates Search Nodes for the specified cluster. operationId: createAtlasSearchDeployment @@ -37555,18 +38421,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchDeployment --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchDeployment --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes: get: description: Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -37615,16 +38489,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexesCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexesCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37673,18 +38553,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}: get: description: Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -37745,16 +38633,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasSearchIndexes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasSearchIndexes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}: delete: description: Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -37813,16 +38707,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -37880,16 +38780,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -37956,18 +38862,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndexByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndexByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}: delete: description: Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent. @@ -38017,16 +38931,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" 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 API Key must have the Project Data Access Read Write role. externalDocs: @@ -38081,16 +39001,22 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}?pretty=true" 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 API Key must have the Project Data Access Admin role. externalDocs: @@ -38148,18 +39074,26 @@ paths: tags: - Atlas Search x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateAtlasSearchIndex --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateAtlasSearchIndex --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule: get: deprecated: true @@ -38199,16 +39133,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule?pretty=true" patch: deprecated: true description: |- @@ -38254,18 +39194,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotSchedule --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotSchedule --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotSchedule" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots: get: deprecated: true @@ -38315,16 +39263,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listLegacySnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listLegacySnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}: delete: deprecated: true @@ -38372,16 +39326,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" get: deprecated: true description: Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -38426,16 +39386,22 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLegacySnapshot --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLegacySnapshot --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true" patch: deprecated: true description: Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). @@ -38487,18 +39453,26 @@ paths: tags: - Legacy Backup x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateLegacySnapshotRetention --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateLegacySnapshotRetention --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status: get: description: Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38534,16 +39508,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getClusterStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getClusterStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -38592,18 +39572,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pinFeatureCompatibilityVersion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release. @@ -38647,18 +39635,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api unpinFeatureCompatibilityVersion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api unpinFeatureCompatibilityVersion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz: get: description: 'Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn''t available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". Deprecated versions: v2-{2023-01-01}' @@ -38729,16 +39725,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/provider/regions: get: description: Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. @@ -38780,16 +39782,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCloudProviderRegions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCloudProviderRegions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/provider/regions?pretty=true" /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade: post: description: Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters. @@ -38831,18 +39839,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedCluster --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedCluster --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless: post: description: Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. @@ -38884,18 +39900,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api upgradeSharedClusterToServerless --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api upgradeSharedClusterToServerless --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/collStats/metrics: get: description: Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request. @@ -38925,16 +39949,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceMetrics --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/collStats/metrics?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api getCollStatsLatencyNamespaceMetrics --help /api/atlas/v2/groups/{groupId}/containers: get: description: Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. @@ -38977,16 +40007,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainerByCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainerByCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers?pretty=true" 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 API Key must have the Project Owner role. operationId: createPeeringContainer @@ -39027,18 +40063,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/{containerId}: delete: description: Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -39081,16 +40125,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" 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 API Key must have the Project Read Only role. operationId: getPeeringContainer @@ -39126,16 +40176,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}?pretty=true" patch: description: Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringContainer @@ -39186,18 +40242,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringContainer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringContainer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/{containerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/containers/all: get: description: Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39227,16 +40291,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringContainers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringContainers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/containers/all?pretty=true" /api/atlas/v2/groups/{groupId}/customDBRoles/roles: get: description: Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39265,16 +40335,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listCustomDatabaseRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listCustomDatabaseRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles?pretty=true" post: description: Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createCustomDatabaseRole @@ -39315,18 +40391,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}: delete: description: Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. @@ -39363,16 +40447,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" get: description: Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getCustomDatabaseRole @@ -39406,16 +40496,22 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}?pretty=true" patch: description: Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateCustomDatabaseRole @@ -39462,18 +40558,26 @@ paths: tags: - Custom Database Roles x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateCustomDatabaseRole --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateCustomDatabaseRole --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation: get: description: Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. @@ -39511,16 +40615,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listFederatedDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listFederatedDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation?pretty=true" post: description: Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createFederatedDatabase @@ -39559,18 +40669,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}: delete: description: Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. @@ -39603,16 +40721,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" get: description: Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getFederatedDatabase @@ -39647,16 +40771,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}?pretty=true" patch: description: Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or higher role. operationId: updateFederatedDatabase @@ -39703,18 +40833,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateFederatedDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateFederatedDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits: get: description: Returns query limits for a federated databases instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -39751,16 +40889,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}: delete: description: Deletes one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -39811,16 +40955,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOneDataFederationInstanceQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOneDataFederationInstanceQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" 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 API Key must have the Project Read Only role. operationId: returnFederatedDatabaseQueryLimit @@ -39871,16 +41021,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnFederatedDatabaseQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnFederatedDatabaseQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}?pretty=true" patch: description: Creates or updates one query limit for one federated database instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: createOneDataFederationQueryLimit @@ -39941,18 +41097,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOneDataFederationQueryLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOneDataFederationQueryLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz: get: description: 'Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -40009,16 +41173,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadFederatedDatabaseQueryLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadFederatedDatabaseQueryLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dataFederation/{tenantName}/queryLogs.gz?pretty=true" /api/atlas/v2/groups/{groupId}/databaseUsers: get: description: Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40048,16 +41218,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true" 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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: createDatabaseUser @@ -40189,18 +41365,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}: delete: description: Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40257,16 +41441,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" get: description: Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getDatabaseUser @@ -40320,16 +41510,22 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}?pretty=true" patch: description: Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles. operationId: updateDatabaseUser @@ -40396,18 +41592,26 @@ paths: tags: - Database Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateDatabaseUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateDatabaseUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs: get: description: Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. @@ -40445,16 +41649,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabaseUserCertificates --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabaseUserCertificates --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs?pretty=true" post: description: |- Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Owner role. @@ -40510,18 +41720,26 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDatabaseUserCertificate --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDatabaseUserCertificate --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: get: description: Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -40594,16 +41812,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByClusterName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByClusterName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true" /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: get: description: Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role. @@ -40673,16 +41897,22 @@ paths: tags: - Access Tracking x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAccessLogsByHostname --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAccessLogsByHostname --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}?pretty=true" /api/atlas/v2/groups/{groupId}/encryptionAtRest: get: description: |- @@ -40712,16 +41942,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest?pretty=true" patch: description: |- Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. @@ -40772,18 +42008,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateEncryptionAtRest --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateEncryptionAtRest --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints: get: description: Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management. @@ -40818,16 +42062,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpointsForCloudProvider --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints?pretty=true" post: description: Creates a private endpoint in the specified region for encryption at rest using customer key management. operationId: createEncryptionAtRestPrivateEndpoint @@ -40868,18 +42118,26 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}: delete: description: Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. @@ -40930,16 +42188,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api requestEncryptionAtRestPrivateEndpointDeletion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" get: description: Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management. operationId: getEncryptionAtRestPrivateEndpoint @@ -40982,16 +42246,22 @@ paths: tags: - Encryption at Rest using Customer Key Management x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getEncryptionAtRestPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getEncryptionAtRestPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/events: get: description: |- @@ -41075,16 +42345,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events?pretty=true" /api/atlas/v2/groups/{groupId}/events/{eventId}: get: description: |- @@ -41131,16 +42407,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/events/{eventId}?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -41169,16 +42451,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listMetricTypes --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listMetricTypes --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements: get: description: Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -41237,16 +42525,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/{indexName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements: get: description: Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process. @@ -41304,16 +42598,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listIndexMetrics --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listIndexMetrics --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/indexes/{databaseName}/{collectionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements: get: description: Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types. @@ -41370,16 +42670,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/integrations: get: description: Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -41413,16 +42719,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listThirdPartyIntegrations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listThirdPartyIntegrations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations?pretty=true" /api/atlas/v2/groups/{groupId}/integrations/{integrationType}: delete: description: Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. If you delete an integration from a project, you remove that integration configuration only for that project. This action doesn't affect any other project or organization's configured `{INTEGRATION-TYPE}` integrations. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. @@ -41471,16 +42783,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" 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 API Key must have the Organization Owner or Project Owner role. operationId: getThirdPartyIntegration @@ -41528,16 +42846,22 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}?pretty=true" 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 API Key must have the Organization Owner or Project Owner role. operationId: createThirdPartyIntegration @@ -41597,18 +42921,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' 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 API Key must have the Organization Owner or Project Owner role. operationId: updateThirdPartyIntegration @@ -41666,18 +42998,26 @@ paths: tags: - Third-Party Integrations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateThirdPartyIntegration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateThirdPartyIntegration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/integrations/{integrationType}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/invites: get: deprecated: true @@ -41713,16 +43053,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -41761,18 +43107,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" post: deprecated: true @@ -41807,18 +43161,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: @@ -41855,16 +43217,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" x-sunset: "2024-10-04" get: deprecated: true @@ -41903,16 +43271,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}?pretty=true" x-sunset: "2024-10-04" patch: deprecated: true @@ -41959,18 +43333,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/invites/{invitationId}" \ + -d '{ }' x-sunset: "2024-10-04" /api/atlas/v2/groups/{groupId}/ipAddresses: get: @@ -42000,16 +43382,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/ipAddresses?pretty=true" /api/atlas/v2/groups/{groupId}/limits: get: description: Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42044,16 +43432,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectLimits --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectLimits --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits?pretty=true" /api/atlas/v2/groups/{groupId}/limits/{limitName}: delete: description: Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. @@ -42120,16 +43514,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" get: description: Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getProjectLimit @@ -42197,16 +43597,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}?pretty=true" patch: description: |- Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. @@ -42284,18 +43690,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setProjectLimit --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setProjectLimit --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/limits/{limitName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations: post: description: |- @@ -42343,18 +43757,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}: get: description: Return details of one cluster migration job. Each push live migration job uses one migration host. Your API Key must have the Organization Member role to successfully call this resource. @@ -42386,16 +43808,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}?pretty=true" /api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover: put: description: Cut over the migrated cluster to MongoDB Atlas. Confirm when the cut over completes. When the cut over completes, MongoDB Atlas completes the live migration process and stops synchronizing with the source cluster. Your API Key must have the Organization Owner role to successfully call this resource. @@ -42427,18 +43855,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api cutoverMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api cutoverMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate: post: description: 'Verifies whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed. Your API Key must have the Organization Owner role to successfully call this resource. Deprecated versions: v2-{2023-01-01}' @@ -42479,18 +43915,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api validateMigration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api validateMigration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}: get: description: Return the status of one migration validation job. Your API Key must have the Organization Owner role to successfully call this resource. @@ -42532,16 +43976,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getValidationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getValidationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/liveMigrations/validate/{validationId}?pretty=true" /api/atlas/v2/groups/{groupId}/maintenanceWindow: delete: description: Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -42567,16 +44017,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resetMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resetMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" 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 API Key must have the Project Owner role. operationId: getMaintenanceWindow @@ -42602,16 +44058,22 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow?pretty=true" 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. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateMaintenanceWindow @@ -42645,18 +44107,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer: post: description: Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -42682,18 +44152,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleMaintenanceAutoDefer --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api toggleMaintenanceAutoDefer --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/maintenanceWindow/defer: post: description: Defers 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. To use this resource, the requesting API Key must have the Project Owner role. @@ -42719,18 +44197,26 @@ paths: tags: - Maintenance Windows x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deferMaintenanceWindow --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deferMaintenanceWindow --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/managedSlowMs: get: description: Get whether the Managed Slow MS feature is enabled. @@ -42757,16 +44243,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getManagedSlowMs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getManagedSlowMs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs?pretty=true" /api/atlas/v2/groups/{groupId}/managedSlowMs/disable: delete: description: Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42793,16 +44285,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/disable" /api/atlas/v2/groups/{groupId}/managedSlowMs/enable: post: description: Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. @@ -42829,18 +44327,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api enableSlowOperationThresholding --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api enableSlowOperationThresholding --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/managedSlowMs/enable" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/mongoDBVersions: get: description: Returns the MongoDB Long Term Support Major Versions available to new clusters in this project. @@ -42908,16 +44414,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectLTSVersions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectLTSVersions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/mongoDBVersions?pretty=true" /api/atlas/v2/groups/{groupId}/peers: get: description: Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -42959,16 +44471,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPeeringConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPeeringConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers?pretty=true" 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 API Key must have the Project Owner role. To learn more about considerations and prerequisites, see the Network Peering Documentation. externalDocs: @@ -43010,18 +44528,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPeeringConnection --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api createPeeringConnection --help /api/atlas/v2/groups/{groupId}/peers/{peerId}: delete: description: Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Owner role. @@ -43059,16 +44585,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" get: description: Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPeeringConnection @@ -43105,16 +44637,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}?pretty=true" patch: description: Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updatePeeringConnection @@ -43162,18 +44700,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePeeringConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePeeringConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/peers/{peerId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines: get: description: Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43203,16 +44749,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelines --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelines --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines?pretty=true" post: description: Creates one Data Lake Pipeline. operationId: createPipeline @@ -43248,18 +44800,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: description: Removes one Data Lake Pipeline. @@ -43296,16 +44856,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" get: description: Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipeline @@ -43342,16 +44908,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}?pretty=true" patch: description: Updates one Data Lake Pipeline. operationId: updatePipeline @@ -43398,18 +44970,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: description: Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43449,16 +45029,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSchedules --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSchedules --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: description: Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43506,16 +45092,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineSnapshots --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineSnapshots --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: description: Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43553,18 +45145,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api pausePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api pausePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: description: Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43602,18 +45202,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api resumePipeline --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api resumePipeline --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: description: Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43661,16 +45269,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPipelineRuns --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPipelineRuns --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: description: Deletes dataset that Atlas generated during the specified pipeline run. @@ -43718,16 +45332,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePipelineRunDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePipelineRunDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" get: description: Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getPipelineRun @@ -43774,16 +45394,22 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPipelineRun --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPipelineRun --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}?pretty=true" /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. @@ -43828,18 +45454,26 @@ paths: tags: - Data Lake Pipelines x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api triggerSnapshotIngestion --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api triggerSnapshotIngestion --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService: get: description: Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -43879,16 +45513,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPrivateEndpointServices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPrivateEndpointServices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}: delete: description: Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting API Key must have the Project Owner role. @@ -43935,16 +45575,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpointService @@ -43992,16 +45638,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint: post: description: Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint. @@ -44061,18 +45713,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}: delete: description: Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting API Key must have the Project Owner role. @@ -44126,16 +45786,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}" 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 API Key must have the Project Read Only role. operationId: getPrivateEndpoint @@ -44190,16 +45856,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting API Key must have the Project Owner role. @@ -44236,18 +45908,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPrivateEndpointService --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPrivateEndpointService --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode: get: description: Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44276,16 +45956,22 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getRegionalizedPrivateEndpointSetting --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode?pretty=true" 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 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. operationId: toggleRegionalizedPrivateEndpointSetting @@ -44320,18 +46006,26 @@ paths: tags: - Private Endpoint Services x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api toggleRegionalizedPrivateEndpointSetting --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api toggleRegionalizedPrivateEndpointSetting --help /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint: get: description: Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. @@ -44369,16 +46063,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint?pretty=true" post: description: |- Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -44426,18 +46126,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}: delete: description: Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. @@ -44482,16 +46190,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" get: description: Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. operationId: getServerlessPrivateEndpoint @@ -44535,16 +46249,22 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}?pretty=true" patch: description: Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessPrivateEndpoint @@ -44595,18 +46315,26 @@ paths: tags: - Serverless Private Endpoints x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateIpMode: get: deprecated: true @@ -44637,16 +46365,22 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyConnectViaPeeringOnlyModeForOneProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode?pretty=true" patch: deprecated: true description: Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44685,18 +46419,26 @@ paths: tags: - Network Peering x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disablePeering --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disablePeering --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateIpMode" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds: get: description: Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. @@ -44730,16 +46472,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDataFederationPrivateEndpoints --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDataFederationPrivateEndpoints --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds?pretty=true" post: description: |- Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. If the endpoint ID already exists and the associated comment is unchanged, Atlas Data Federation makes no change to the endpoint ID list. If the endpoint ID already exists and the associated comment is changed, Atlas Data Federation updates the comment value only in the endpoint ID list. If the endpoint ID doesn't exist, Atlas Data Federation appends the new endpoint to the list of endpoints in the endpoint ID list. Each region has an associated service name for the various endpoints in each region. @@ -44793,18 +46541,26 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}: delete: description: Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -44842,16 +46598,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}" get: description: Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. operationId: getDataFederationPrivateEndpoint @@ -44890,16 +46652,22 @@ paths: tags: - Data Federation x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDataFederationPrivateEndpoint --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDataFederationPrivateEndpoint --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/privateNetworkSettings/endpointIds/{endpointId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes: get: description: Returns details of all processes for the specified project. A MongoDB process can be either a `mongod` or `mongos`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44929,16 +46697,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listAtlasProcesses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listAtlasProcesses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}: get: description: Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -44973,16 +46747,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getAtlasProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getAtlasProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements: get: description: Get a list of the Coll Stats Latency process-level measurements for the given namespace @@ -45052,16 +46832,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespaceHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces: get: description: Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window. @@ -45091,16 +46877,22 @@ paths: tags: - Collection Level Metrics x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getCollStatsLatencyNamespacesForHost --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getCollStatsLatencyNamespacesForHost --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases: get: description: Returns the list of databases running on the specified host for the specified project. `M0` free clusters, `M2`, `M5`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45138,16 +46930,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDatabases --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDatabases --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}: get: description: Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45188,16 +46986,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabase --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabase --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements: get: description: Returns the measurements of one database for the specified host for the specified project. Returns the database's on-disk storage space based on the MongoDB `dbStats` command output. To calculate some metric series, Atlas takes the rate between every two adjacent points. For these metric series, the first data point has a null value because Atlas can't calculate a rate for the first data point given the query time range. Atlas retrieves database metrics every 20 minutes but reduces frequency when necessary to optimize database performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45264,16 +47068,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDatabaseMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDatabaseMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks: get: description: Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45311,16 +47121,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskPartitions --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskPartitions --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}: get: description: Returns measurement details for one disk or partition for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45360,16 +47176,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements: get: description: |- @@ -45452,16 +47274,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getDiskMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getDiskMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/measurements: get: description: |- @@ -45655,16 +47483,22 @@ paths: tags: - Monitoring and Logs x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getHostMeasurements --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getHostMeasurements --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/measurements?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces: get: description: Returns up to 20 namespaces for collections experiencing slow queries on the specified host. If you specify a secondary member of a replica set that hasn't received any database read operations, the endpoint doesn't return any namespaces. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45719,16 +47553,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueryNamespaces --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueryNamespaces --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/namespaces?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs: get: description: Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. @@ -45800,16 +47640,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSlowQueries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSlowQueries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs?pretty=true" /api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes: get: description: Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. @@ -45888,16 +47734,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSuggestedIndexes --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes?pretty=true" - - label: Atlas CLI - lang: cURL - source: atlas api listSuggestedIndexes --help /api/atlas/v2/groups/{groupId}/pushBasedLogExport: delete: description: Disables the push-based log export feature by resetting the project level settings to its default configuration. @@ -45928,16 +47780,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deletePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deletePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" get: description: Fetches the current project level settings for the push-based log export feature. operationId: getPushBasedLogConfiguration @@ -45967,16 +47825,22 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport?pretty=true" patch: description: Updates the project level settings for the push-based log export feature. operationId: updatePushBasedLogConfiguration @@ -46014,18 +47878,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updatePushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updatePushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' post: description: Configures the project level settings for the push-based log export feature. operationId: createPushBasedLogConfiguration @@ -46063,18 +47935,26 @@ paths: tags: - Push-Based Log Export x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createPushBasedLogConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createPushBasedLogConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/pushBasedLogExport" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}: post: description: Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -46113,18 +47993,26 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api loadSampleDataset --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api loadSampleDataset --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}: get: description: Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role. @@ -46159,16 +48047,22 @@ paths: tags: - Clusters x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getSampleDatasetLoadStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getSampleDatasetLoadStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless: get: description: Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46198,16 +48092,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless?pretty=true" post: description: Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessInstance @@ -46244,18 +48144,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs: get: description: Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46296,16 +48204,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackupRestoreJobs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackupRestoreJobs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs?pretty=true" post: description: Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createServerlessBackupRestoreJob @@ -46353,18 +48267,26 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}: get: description: Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -46411,16 +48333,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackupRestoreJob --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackupRestoreJob --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots: get: description: Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46461,16 +48389,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServerlessBackups --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServerlessBackups --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}: get: description: Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -46517,16 +48451,22 @@ paths: tags: - Cloud Backups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessBackup --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessBackup --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}?pretty=true" /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing: get: description: Get whether the Serverless Auto Indexing feature is enabled. @@ -46562,16 +48502,22 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing?pretty=true" post: description: Set whether the Serverless Auto Indexing feature is enabled. operationId: setServerlessAutoIndexing @@ -46611,18 +48557,26 @@ paths: tags: - Performance Advisor x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api setServerlessAutoIndexing --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api setServerlessAutoIndexing --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serverless/{name}: delete: description: Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -46662,16 +48616,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" get: description: Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getServerlessInstance @@ -46710,16 +48670,22 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}?pretty=true" patch: description: Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateServerlessInstance @@ -46763,18 +48729,26 @@ paths: tags: - Serverless Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServerlessInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServerlessInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serverless/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts: get: description: Returns list of Service Accounts for a project with service account details. @@ -46805,16 +48779,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts?pretty=true" post: description: Creates and assigns the specified Service Account to the specified Project. operationId: createProjectServiceAccount @@ -46850,18 +48830,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: delete: description: Removes one Service Account from the specified project. @@ -46897,16 +48885,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" get: description: Get project Service Account Details. operationId: getProjectServiceAccount @@ -46940,16 +48934,22 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account in Project. operationId: updateProjectServiceAccount @@ -46992,18 +48992,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' post: description: Assigns the specified organization Service Account to the specified project. operationId: addProjectServiceAccount @@ -47048,18 +49056,26 @@ paths: tags: - Groups x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addProjectServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addProjectServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/settings: get: description: Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. @@ -47090,16 +49106,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings?pretty=true" 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 API Key must have the Project Owner role. operationId: updateProjectSettings @@ -47136,18 +49158,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams: get: description: Returns all stream instances for the specified project. @@ -47176,16 +49206,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams?pretty=true" post: description: Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: createStreamInstance @@ -47220,18 +49256,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. @@ -47268,16 +49312,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" get: description: Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. operationId: getStreamInstance @@ -47317,16 +49367,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}?pretty=true" patch: description: Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role. operationId: updateStreamInstance @@ -47371,18 +49427,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs: get: description: 'Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip".' @@ -47440,16 +49504,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadStreamTenantAuditLogs --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadStreamTenantAuditLogs --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections: get: description: Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. @@ -47486,16 +49556,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamConnections --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamConnections --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections?pretty=true" post: description: Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role. operationId: createStreamConnection @@ -47538,18 +49614,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}: delete: description: Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47592,16 +49676,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" get: description: Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role. operationId: getStreamConnection @@ -47640,16 +49730,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}?pretty=true" patch: description: Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: updateStreamConnection @@ -47700,18 +49796,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateStreamConnection --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateStreamConnection --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor: post: description: Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47755,18 +49859,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}: delete: description: Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47807,16 +49919,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" get: description: Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. operationId: getStreamProcessor @@ -47858,16 +49976,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}?pretty=true" /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start: post: description: Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47910,18 +50034,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api startStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api startStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop: post: description: Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -47964,18 +50096,26 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api stopStreamProcessor --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api stopStreamProcessor --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors: get: description: Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role. @@ -48015,16 +50155,22 @@ paths: tags: - Streams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listStreamProcessors --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listStreamProcessors --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors?pretty=true" /api/atlas/v2/groups/{groupId}/teams: get: description: Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. @@ -48060,16 +50206,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams?pretty=true" 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 API Key must have the Project Owner role. externalDocs: @@ -48113,18 +50265,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addAllTeamsToProject --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addAllTeamsToProject --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role. @@ -48166,16 +50326,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" 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 API Key must have the Project Owner role. externalDocs: @@ -48226,18 +50392,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateTeamRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateTeamRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity: get: description: Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48264,16 +50438,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity?pretty=true" patch: description: |- Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48311,18 +50491,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api saveLDAPConfiguration --help + - label: curl (Service Accounts) + lang: cURL + source: |- + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ + -d '{ }' + - label: curl (Digest) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ --digest \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity" \ -d '{ }' - - label: Atlas CLI - lang: cURL - source: atlas api saveLDAPConfiguration --help /api/atlas/v2/groups/{groupId}/userSecurity/customerX509: delete: description: |- @@ -48351,16 +50539,22 @@ paths: tags: - X.509 Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api disableCustomerManagedX509 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api disableCustomerManagedX509 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping: delete: description: Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48387,16 +50581,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify: post: description: Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48432,18 +50632,26 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api verifyLDAPConfiguration --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api verifyLDAPConfiguration --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}: get: description: Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48479,16 +50687,22 @@ paths: tags: - LDAP Configuration x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getLDAPConfigurationStatus --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getLDAPConfigurationStatus --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}?pretty=true" /api/atlas/v2/groups/{groupId}/users: get: description: Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. @@ -48530,16 +50744,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listProjectUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listProjectUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true" /api/atlas/v2/groups/{groupId}/users/{userId}: delete: description: Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role. @@ -48577,16 +50797,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeProjectUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeProjectUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}" /api/atlas/v2/groups/{groupId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role. @@ -48633,18 +50859,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateProjectRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateProjectRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/uss: get: description: Returns details for all USS instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. @@ -48674,16 +50908,22 @@ paths: tags: - USS Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listUSSInstances --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listUSSInstances --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss?pretty=true" post: description: Creates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: createUSSInstance @@ -48720,18 +50960,26 @@ paths: tags: - USS Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUSSInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUSSInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss" \ + -d '{ }' /api/atlas/v2/groups/{groupId}/uss/{name}: delete: description: Removes one USS instance from the specified project. The USS instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role. @@ -48771,16 +51019,22 @@ paths: tags: - USS Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteUSSInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteUSSInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}" x-xgen-changelog: "2025-03-02": Changelog test entry. get: @@ -48821,16 +51075,22 @@ paths: tags: - USS Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUSSInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUSSInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}?pretty=true" patch: description: Updates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role. operationId: updateUSSInstance @@ -48874,18 +51134,26 @@ paths: tags: - USS Instances x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateUSSInstance --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateUSSInstance --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/uss/{name}" \ + -d '{ }' /api/atlas/v2/groups/{groupId}:migrate: post: description: Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role. @@ -48918,18 +51186,26 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api migrateProjectToAnotherOrg --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api migrateProjectToAnotherOrg --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}:migrate" \ + -d '{ }' /api/atlas/v2/groups/byName/{groupName}: 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 API Key must have the Project Read Only role. @@ -48969,16 +51245,22 @@ paths: tags: - Projects x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getProjectByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getProjectByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/byName/{groupName}?pretty=true" /api/atlas/v2/orgs: get: description: Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role. @@ -49018,16 +51300,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs?pretty=true" post: description: Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation. operationId: createOrganization @@ -49067,18 +51355,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}: delete: description: |- @@ -49117,16 +51413,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" get: description: Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. operationId: getOrganization @@ -49158,16 +51460,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}?pretty=true" patch: description: Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: renameOrganization @@ -49206,18 +51514,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameOrganization --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameOrganization --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys: get: description: Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. @@ -49250,16 +51566,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeys --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeys --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -49295,18 +51617,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}: delete: description: Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization Owner role. @@ -49345,16 +51675,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" 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 API Key must have the Organization Member role. externalDocs: @@ -49392,16 +51728,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}?pretty=true" 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. externalDocs: @@ -49448,18 +51790,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateApiKey --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateApiKey --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList: get: description: Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. @@ -49501,16 +51851,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listApiKeyAccessListsEntries --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listApiKeyAccessListsEntries --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList?pretty=true" 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 API Key must have the Read Write role. operationId: createApiKeyAccessList @@ -49561,18 +51917,26 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}: delete: description: Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role. In addition, you cannot remove the requesting IP address from the requesting organization API key. @@ -49623,16 +51987,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteApiKeyAccessListEntry --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteApiKeyAccessListEntry --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}" 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 API Key must have the Organization Member role. externalDocs: @@ -49680,16 +52050,22 @@ paths: tags: - Programmatic API Keys x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getApiKeyAccessList --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getApiKeyAccessList --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/apiKeys/{apiUserId}/accessList/{ipAddress}?pretty=true" /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage: post: description: Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results. @@ -49724,18 +52100,26 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}: get: description: Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data. @@ -49780,16 +52164,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createCostExplorerQueryProcess_1 --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createCostExplorerQueryProcess_1 --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}?pretty=true" /api/atlas/v2/orgs/{orgId}/events: get: description: |- @@ -49851,16 +52241,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationEvents --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationEvents --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events?pretty=true" /api/atlas/v2/orgs/{orgId}/events/{eventId}: get: description: |- @@ -49907,16 +52303,22 @@ paths: tags: - Events x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationEvent --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationEvent --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/events/{eventId}?pretty=true" /api/atlas/v2/orgs/{orgId}/federationSettings: get: description: Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. @@ -49947,16 +52349,22 @@ paths: tags: - Federated Authentication x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getFederationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getFederationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/federationSettings?pretty=true" /api/atlas/v2/orgs/{orgId}/groups: get: description: |- @@ -50003,16 +52411,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/invites: get: description: Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50051,16 +52465,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationInvitations --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationInvitations --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitation @@ -50097,18 +52517,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' post: description: Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: createOrganizationInvitation @@ -50145,18 +52573,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invites/{invitationId}: delete: description: Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization Owner role. @@ -50193,16 +52629,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" get: description: Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization Owner role. operationId: getOrganizationInvitation @@ -50240,16 +52682,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationInvitation --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationInvitation --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}?pretty=true" patch: description: Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. Use the Return All Organization Invitations endpoint to retrieve IDs for all pending organization invitations. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationInvitationById @@ -50295,18 +52743,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationInvitationById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationInvitationById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invites/{invitationId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/invoices: get: description: |- @@ -50397,16 +52853,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}: get: description: |- @@ -50450,16 +52912,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv: get: description: |- @@ -50504,16 +52972,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api downloadInvoiceCSV --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api downloadInvoiceCSV --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search: get: description: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. @@ -50559,16 +53033,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api queryLineItemsFromSingleInvoice --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api queryLineItemsFromSingleInvoice --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search?pretty=true" /api/atlas/v2/orgs/{orgId}/invoices/pending: get: description: Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can view linked invoices if you have the Organization Billing Admin or Organization Owner Role. @@ -50597,16 +53077,22 @@ paths: tags: - Invoices x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listPendingInvoices --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listPendingInvoices --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/invoices/pending?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -50637,16 +53123,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listSourceProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listSourceProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects?pretty=true" /api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens: delete: description: Remove one organization link and its associated public API key. MongoDB Atlas uses the link-token for push live migrations only. Live migrations (push) let you 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. @@ -50674,16 +53166,22 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" 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. operationId: createLinkToken @@ -50718,18 +53216,26 @@ paths: tags: - Cloud Migration Service x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createLinkToken --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createLinkToken --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/liveMigrations/linkTokens" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: description: Returns list of Service Accounts with service account details. @@ -50760,16 +53266,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccounts --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccounts --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts?pretty=true" post: description: Create Service Account containing client id and client secrets. operationId: createServiceAccount @@ -50804,18 +53316,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: delete: description: Delete Service Account. @@ -50848,16 +53368,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" get: description: Get Service Account Details. operationId: getServiceAccount @@ -50891,16 +53417,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}?pretty=true" patch: description: Update Service Account. operationId: updateServiceAccount @@ -50943,18 +53475,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateServiceAccount --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateServiceAccount --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: get: description: Returns list of Service Account projects. @@ -50991,16 +53531,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listServiceAccountProjects --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listServiceAccountProjects --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups?pretty=true" /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: post: description: Create Service Account secret. @@ -51042,18 +53588,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: delete: description: Delete Service Account Secret. @@ -51092,16 +53646,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteServiceAccountSecret --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteServiceAccountSecret --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" /api/atlas/v2/orgs/{orgId}/settings: get: description: Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. @@ -51132,16 +53692,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings?pretty=true" patch: description: Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role. operationId: updateOrganizationSettings @@ -51178,18 +53744,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationSettings --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationSettings --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/settings" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams: get: description: Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. @@ -51226,16 +53800,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationTeams --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationTeams --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -51277,18 +53857,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}: delete: description: Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization Owner role. @@ -51331,16 +53919,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api deleteTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api deleteTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" 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 API Key must have the Organization Member role. externalDocs: @@ -51382,16 +53976,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamById --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamById --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}?pretty=true" 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 API Key must have the Organization Owner role. externalDocs: @@ -51442,18 +54042,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api renameTeam --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api renameTeam --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PATCH "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users: get: description: Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -51500,16 +54108,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listTeamUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listTeamUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users?pretty=true" post: description: Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization Owner role. externalDocs: @@ -51562,18 +54176,26 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api addTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api addTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users" \ + -d '{ }' /api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Owner role. @@ -51623,16 +54245,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeTeamUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeTeamUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/{teamId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}: get: description: Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. @@ -51672,16 +54300,22 @@ paths: tags: - Teams x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getTeamByName --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getTeamByName --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}?pretty=true" /api/atlas/v2/orgs/{orgId}/users: get: description: Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. @@ -51715,16 +54349,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api listOrganizationUsers --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api listOrganizationUsers --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users?pretty=true" /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -51765,16 +54405,22 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api removeOrganizationUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api removeOrganizationUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X DELETE "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}" /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. @@ -51821,18 +54467,26 @@ paths: tags: - Organizations x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api updateOrganizationRoles --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api updateOrganizationRoles --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X PUT "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" \ + -d '{ }' /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access). @@ -51853,16 +54507,22 @@ paths: tags: - Root x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api returnAllControlPlaneIPAddresses --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api returnAllControlPlaneIPAddresses --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/unauth/controlPlaneIPAddresses?pretty=true" /api/atlas/v2/users: post: description: |- @@ -51902,18 +54562,26 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api createUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ - --header "Content-Type: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ -d '{ }' - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api createUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + --header "Content-Type: application/json" \ + -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \ + -d '{ }' /api/atlas/v2/users/{userId}: get: description: Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. You can't use this endpoint to return information on an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. You can always retrieve your own user account. If you are the owner of a MongoDB Cloud organization or project, you can also retrieve the user profile for any user with membership in that organization or project. To use this resource, the requesting API Key can have any role. @@ -51950,16 +54618,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUser --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUser --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/{userId}?pretty=true" /api/atlas/v2/users/byName/{userName}: get: description: Returns the details for one MongoDB Cloud user account with the specified username. You can't use this endpoint to return information about an API Key. To return information about an API Key, use the [Return One Organization](#tag/Organizations/operation/getOrganization) API Key endpoint. To use this resource, the requesting API Key can have any role. @@ -51994,16 +54668,22 @@ paths: tags: - MongoDB Cloud Users x-codeSamples: - - label: curl + - label: Atlas CLI + lang: cURL + source: atlas api getUserByUsername --help + - label: curl (Service Accounts) lang: cURL source: |- - curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" \ - --digest \ + curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \ --header "Accept: application/vnd.atlas.2025-01-01+json" \ -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" - - label: Atlas CLI + - label: curl (Digest) lang: cURL - source: atlas api getUserByUsername --help + source: |- + curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \ + --digest \ + --header "Accept: application/vnd.atlas.2025-01-01+json" \ + -X GET "https://cloud.mongodb.com/api/atlas/v2/users/byName/{userName}?pretty=true" servers: - url: https://cloud.mongodb.com tags: